Title: Github README Author: Jason Stallings Published: January 1, 2015 Last modified: June 7, 2016 --- Search plugins 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. ![](https://s.w.org/plugins/geopattern-icon/github-readme.svg) # Github README By [Jason Stallings](https://profiles.wordpress.org/octalmage/) [Download](https://downloads.wordpress.org/plugin/github-readme.zip) * [Details](https://pcd.wordpress.org/plugins/github-readme/#description) * [Reviews](https://pcd.wordpress.org/plugins/github-readme/#reviews) * [Development](https://pcd.wordpress.org/plugins/github-readme/#developers) [Support](https://wordpress.org/support/plugin/github-readme/) ## Description 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. ## Reviews ![](https://secure.gravatar.com/avatar/0be55fa25959854681627b0d9595d1b4e0fe00bf4fd4dcb29f2ca71c3dc2fb07? s=60&d=retro&r=g) ### 󠀁[Very Good!](https://wordpress.org/support/topic/very-good-1797/)󠁿 [Odyno](https://profiles.wordpress.org/odyno/) January 2, 2017 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. [ Read all 4 reviews ](https://wordpress.org/support/plugin/github-readme/reviews/) ## Contributors & Developers “Github README” is open source software. The following people have contributed to this plugin. Contributors * [ Jason Stallings ](https://profiles.wordpress.org/octalmage/) * [ olensmar ](https://profiles.wordpress.org/olensmar/) * [ ianmjones ](https://profiles.wordpress.org/ianmjones/) * [ nlenkowski ](https://profiles.wordpress.org/nlenkowski/) [Translate “Github README” into your language.](https://translate.wordpress.org/projects/wp-plugins/github-readme) ### Interested in development? [Browse the code](https://plugins.trac.wordpress.org/browser/github-readme/), check out the [SVN repository](https://plugins.svn.wordpress.org/github-readme/), or subscribe to the [development log](https://plugins.trac.wordpress.org/log/github-readme/) by [RSS](https://plugins.trac.wordpress.org/log/github-readme/?limit=100&mode=stop_on_copy&format=rss). ## Changelog #### 0.2.0 * Improved markdown rendering with MarkdownExtra. Special thanks to nlenkowski! #### 0.1.1 * 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! #### 0.1.0 * Added new github_markdown and github_wikipage shortcodes (thanks olensmar!). #### 0.0.3 * Fixed plugin name. #### 0.0.2 * Fixed plugin header. #### 0.0.1 * First Version. Stable so far! ## Meta * Version **0.2.0** * Last updated **10 years ago** * Active installations **20+** * WordPress version ** 3.0.1 or higher ** * Tested up to **4.5.33** * Language * [English (US)](https://wordpress.org/plugins/github-readme/) * Tags * [embed](https://pcd.wordpress.org/plugins/tags/embed/)[Github](https://pcd.wordpress.org/plugins/tags/github/) [markdown](https://pcd.wordpress.org/plugins/tags/markdown/)[readme](https://pcd.wordpress.org/plugins/tags/readme/) [shortcode](https://pcd.wordpress.org/plugins/tags/shortcode/) * [Advanced View](https://pcd.wordpress.org/plugins/github-readme/advanced/) ## Ratings 5 out of 5 stars. * [ 4 5-star reviews ](https://wordpress.org/support/plugin/github-readme/reviews/?filter=5) * [ 0 4-star reviews ](https://wordpress.org/support/plugin/github-readme/reviews/?filter=4) * [ 0 3-star reviews ](https://wordpress.org/support/plugin/github-readme/reviews/?filter=3) * [ 0 2-star reviews ](https://wordpress.org/support/plugin/github-readme/reviews/?filter=2) * [ 0 1-star reviews ](https://wordpress.org/support/plugin/github-readme/reviews/?filter=1) [Add my review](https://wordpress.org/support/plugin/github-readme/reviews/#new-post) [See all reviews](https://wordpress.org/support/plugin/github-readme/reviews/) ## Contributors * [ Jason Stallings ](https://profiles.wordpress.org/octalmage/) * [ olensmar ](https://profiles.wordpress.org/olensmar/) * [ ianmjones ](https://profiles.wordpress.org/ianmjones/) * [ nlenkowski ](https://profiles.wordpress.org/nlenkowski/) ## Support Got something to say? Need help? [View support forum](https://wordpress.org/support/plugin/github-readme/) ## Donate Would you like to support the advancement of this plugin? [ Donate to this plugin ](http://jason.stallin.gs)