This plugin hasn’t been tested with the latest 3 major releases of WordPress. It may no longer be maintained or supported and may have compatibility issues when used with more recent versions of WordPress.



Github README is a plugin that allows you to embed markdown from GitHub in a page or post using a simple shortcode.



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.


This shortcode embeds any markdown file found in the repository.

[github_markdown repo=”octalmage/Marknote” file=””]

trim, branch, and cache (seconds to cache) also supported.


This shortcode embeds pages from a project’s wiki.

[github_wikipage repo=”octalmage/Marknote” page=”Syntax”]

trim and cache also supported.


جنوری 2, 2017
As described… it work fine and very well! One suggestion: from the guide the relative images are resolved with absolute path on the github repository.
سارے 4 ریویو پڑھو

Contributors & Developers

“Github README” is open source software. The following people have contributed to this plugin.

حصہ پاوݨ آلے

“Github README&#8221 دا آپݨی زبان وچ ترجمہ کرو۔

ڈیویلپمنٹ وچ دلچسپی ہے؟

Browse the code, check out the SVN repository, or subscribe to the development log by RSS.

تبدیلی لاگ


  • Improved markdown rendering with MarkdownExtra.

Special thanks to nlenkowski!


  • Add “cache” attribute to the github_readme shortcode.
  • Add “branch” attribute to the github_readme shortcode.
  • Add the ability to use the shortcode_atts_{$shortcode} filter.
  • Fix transients so they are properly referenced when attributes are changed.

Special thanks to ianmjones!


  • Added new github_markdown and github_wikipage shortcodes (thanks olensmar!).


  • Fixed plugin name.


  • Fixed plugin header.


  • First Version. Stable so far!