Github README
Github README is a plugin that allows you to embed markdown from GitHub in a page or post using a simple shortcode.
Consider an alternative
Github README shows warning signs in 2026 — compare the alternatives below before installing. It runs on 20+ sites, is rated 5/5 and was last updated 10 years ago, and scores 31/100 on our health check.
- Small user base (20+ active installs)
- Very few reviews so far
- No update in 10 years
- Only tested up to WordPress 4.5 (latest is 7.1)
How does it stack up?
Side-by-side on installs, updates, ratings & support
Daily downloads
Download spikes usually follow a new release — each site that auto-updates counts as a download.
Rankings
Where Github README stands todayWordPress.org search rankings
Live position in the plugin search, top 100| Keyword | Position |
|---|---|
| embed | >100 |
| Github | >100 |
| markdown | >100 |
| readme | >100 |
| shortcode | >100 |
Version adoption
Share of active sites per release.
Rating breakdown
★★★★★★★★★★ 5 from 4 reviews
About Github README
From the official readme · v0.2.0Description
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.
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!
For developers
Is this your plugin? Show off the numbers.
Add a live badge to your site, docs or GitHub README. It updates on its own — no account needed.
Best Github README alternatives
All embed plugins →
FAQ
Github README: quick answers
Straight answers, pulled from live WordPress.org data.
Live data from WordPress.org · checked Sep 26, 2026
Is Github README free?
Yes. Github README is free to download and use from the official WordPress.org plugin directory.
Is Github README safe to use in 2026?
Github README shows warning signs in 2026 — compare the alternatives below before installing. It runs on 20+ sites, is rated 5/5 and was last updated 10 years ago, and scores 31/100 on our health check.
How many websites use Github README?
Github README is active on 20+ WordPress websites and has been downloaded 3,517 times since it launched in January 2015. It was downloaded 51 times in the last 30 days.
Does Github README work with WordPress 7.1?
Github README is officially tested up to WordPress 4.5.33, while the latest release is 7.1.2. It may still work, but try it on a staging site first.
When was Github README last updated?
The latest version, 0.2.0, was released on June 7, 2016 (10 years ago).
Who makes Github README?
Github README is developed and maintained by Jason Stallings.
What are the best alternatives to Github README?
The most popular alternatives to Github README are EmbedPress (100K+ installs), iframe (60K+ installs) and Advanced iFrame (40K+ installs).
Powered by PageForge
Want thousands of pages that rank like these? Build them in an afternoon.
This directory runs on the same engine as PageForge. Turn any spreadsheet, CSV or API into thousands of fast, SEO-ready WordPress pages — with schema, internal links and AI-written copy baked in.
- CSV, Google Sheets & API data sources
- AI content, schema & internal links per page
- Works with Elementor, Gutenberg, Yoast & Rank Math
- Free on WordPress.org — no credit card
