Edward Caissie

A collection of functions and code that can be used to extend the capabilities of WordPress Parent-Themes and Child-Themes. 
* Copyright 2011-2014 Edward Caissie (email : edward.caissie@gmail.com)
This program is free software; you can redistribute it and/or modify 
 it under the terms of the GNU General Public License version 2, 
 as published by the Free Software Foundation.
You may NOT assume that you can use any other version of the GPL.
This program is distributed in the hope that it will be useful, 
 but WITHOUT ANY WARRANTY; without even the implied warranty of 
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 
 GNU General Public License for more details.
You should have received a copy of the GNU General Public License 
 along with this program; if not, write to the Free Software 
 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
The license for this software can also likely be found here: 
 http://www.gnu.org/licenses/gpl-2.0.html
<ul>
<li>
Please note, support may be available on the WordPress Support forums; but, it may be faster to visit http://buynowshop.com/plugins/bns-theme-add-ins/ and leave a comment with the issue you are experiencing.
</li>
<li>
This plugin utilizes three text files if included with the active theme, although these files are not required for the plugin to work correctly they will enhance its functionality if they exist:
<ul>
<li><code>readme.txt</code></li>
<li><code>changelog.txt</code></li>
<li><code>support.txt</code></li>
</ul>
</li>
</ul>

BNS Theme Add-Ins

Extend the capabilities of WordPress Parent-Themes and Child-Themes

Jason Stallings

ianmjones

olensmar

nlenkowski

Github README is a plugin that allows you to embed markdown from GitHub in a page or post using a simple shortcode.
Usage:
github_readme
This shortcode embeds the project’s readme.
[github_readme repo=”octalmage/Marknote”]
You can also trim lines from the top of the readme using the “trim” option:
[github_readme repo=”octalmage/Marknote” trim=”3″]
This is useful for removing titles since your page/post will most likely already have one.
github_markdown
This shortcode embeds any markdown file found in the repository.
[github_markdown repo=”octalmage/Marknote” file=”README.md”]
trim, branch, and cache (seconds to cache) also supported.
github_wikipage
This shortcode embeds pages from a project’s wiki.
[github_wikipage repo=”octalmage/Marknote” page=”Syntax”]
trim and cache also supported.

Github README

As described... it work fine and very well!

One suggestion: from the guide https://guides.github.com/features/mastering-markdown/ the relative images are resolved with absolute path on the github repository.

Very Good!

Easily embed GitHub READMEs in pages/posts.

BNS Theme Add-Ins vs Github README