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.

Andrey Matin

Brief is a WordPress plugin to show dashboard widget with development reports, readme, documentation from developer to client. 
The plugin supports markdown format. Developer can also add brand logo and link into report widget by configuration panel.
<h4>Features</h4>
<ol>
<li>Changelog in Markdown format</li>
<li>Readme in Markdown format</li>
<li>Brand Logo/Link</li>
<li>Enable/Disable dashboard widget</li>
</ol>
<h4>Privacy notices</h4>
This plugin does not:
<ul>
<li>track users by stealth;</li>
<li>write any user personal data to the database;</li>
<li>send any data to external servers;</li>
<li>use cookies.</li>
</ul>
<h4>Vendor JavaScript Libraries</h4>
<ul>
<li>jQuery Library <a href="https://jquery.com/" rel="nofollow ugc">jQuery</a></li>
<li>JavaScript converter Markdown to HTML <a href="https://github.com/showdownjs/showdown" rel="nofollow ugc">showdown.js</a></li>
</ul>
<h3>How to use</h3>
<ol>
<li>After installation please visit ‘Admin area’ – ‘Settings’ – ‘Brief’</li>
<li>Check ‘Enable’ on the ‘Brief’ page</li>
<li>Optionally add Brand logo and fill Developer Profile URL</li>
<li>Update Changelog textarea in Markdown format</li>
<li>Update Readme teaxtarea in Markdown format by technical documentation</li>
</ol>
Changes will appear at ‘Dashboard’ area ‘Brief’ widget

Github README vs Brief