Markdown Renderer for GitHub brings GitHub Flavored Markdown (GFM) rendering to WordPress for technical blogs, documentation sites, tutorials, code portfolios, and developer resources. Add Markdown in the block editor or with the [gfmr_markdown] shortcode, then render code, tables, task lists, diagr
PricingFree downloadThe WordPress.org download is free. Pro versions, add-ons or external services may cost extra.
CompatibilityRequires WordPress 6.8 and PHP 8.2.
SourceWordPress plugins · Oct 21, 2026
01 / Source details
Aboutthistool.
Markdown Renderer for GitHub brings GitHub Flavored Markdown (GFM) rendering to WordPress for technical blogs, documentation sites, tutorials, code portfolios, and developer resources. Add Markdown in the block editor or with the [gfmr_markdown] shortcode, then render code, tables, task lists, diagrams, and charts on the front end.
The free plugin includes:
GitHub Flavored Markdown rendering with tables, task lists, strikethrough, autolinks, footnotes, and emoji shortcodes such as :rocket:
Native grammars for 30+ programming languages, plus fallback handling for many more
GitHub Light, GitHub Dark, and system-aware code themes
Mermaid diagrams with interactive controls and an auto/light/dark theme setting (auto follows the code theme and visitor OS)
8 chart types through Chart.js charts from chart fenced code blocks
KaTeX math from GitHub-compatible math fenced code blocks, $$...$$ , $...$ , and [latex] shortcodes
Optional PlantUML rendering through a configured external PlantUML/Kroki server
Table of Contents, structured data, multilingual URL options, and server-side rendering controls
A built-in admin manual with Getting Started, Usage, FAQ, Troubleshooting, Support, and System Info tabs
WordPress Abilities API support on WordPress 6.9+ for AI agents such as Claude Code and Codex
Pro is a separate, standalone plugin (it bundles all Free features) that may provide advanced workflow features such as enhanced code-block options, custom themes, higher-level AI orchestration, and priority support. Core Markdown, syntax highlighting, Mermaid, Chart.js, PlantUML, and the basic settings are included in the free plugin.
Detailed user guidance is available inside the plugin settings screen after activation. This keeps the manual, FAQ, troubleshooting, support guidance, and non-secret system information close to the WordPress admin workflow without requiring a separate documentation website.
On WordPress 6.9 and later, this plugin registers Abilities API abilities so AI coding agents such as Claude Code and Codex can work with it conversationally instead of through manual settings screens. An agent can read the current configuration, look up what each setting does and which values it accepts, and apply changes on request; the standalone Pro plugin extends this with previewing rendered Markdown and drafting posts directly, always saved as a draft. Every ability requires the same manage_options capability as the settings screen, and turning on a destructive setting needs an explicit confirmation from the request, so an agent cannot silently change security-sensitive behavior. Abilities are exposed through the standard WordPress REST API and, when a compatible MCP bridge is active, through the Model Context Protocol as well. On WordPress 6.8, this plugin’s core Markdown rendering works the same as always and the agent abilities are simply not registered.
Technical Requirements
WordPress 6.8 or higher
PHP 8.2 or higher
Modern browser with JavaScript enabled
Recommended: 128MB+ PHP memory limit
Recommended: gzip or Brotli compression enabled for static JavaScript on your web server
Why server compression matters: The syntax-highlighting and diagram libraries are large when uncompressed (Shiki ~2.35 MB, Mermaid ~3.2 MB) but shrink dramatically when delivered with gzip or Brotli (Shiki ~302 KB, Mermaid ~908 KB). For the best front-end performance, ensure your web server compresses static JavaScript (for example mod_deflate/mod_brotli on Apache, or the gzip/brotli directives on nginx). Most managed hosts and CDNs enable this by default. The plugin adds a Tools → Site Health check that reports whether these bundles are actually being served compressed.
Support
For support, please visit the WordPress.org support forum for this plugin. Our team actively monitors and responds to support requests.
Before posting a support request: * Check the FAQ section above for common questions * Ensure you’re using the latest version of the plugin * Include your WordPress and PHP versions in your support request
Feature Requests: We welcome feature suggestions! Please post them in the support forum with detailed descriptions of your use case.
Source Code
This plugin uses build tools for development efficiency.
Source Code Access: * GitHub Repository : https://github.com/my-biz-dev/markdown-renderer-for-github * License : GPL v2 or later * Development Branch : main
Build Instructions: 1. Install Node.js 22 LTS (see .nvmrc) 2. Install dependencies with npm install 3. Build with npm run build 4. Run tests with npm run test
Developer Resources: * Development Environment Setup : See CLAUDE.md and docs/DEVELOPMENT.md * Contributing : See CONTRIBUTING.md * Build Process Details : See BUILD.md
Third Party Services
By default this plugin runs entirely on your own server. The core rendering libraries are bundled locally and make no external requests:
Shiki syntax highlighter – served from your WordPress installation (no CDN)
Mermaid diagram renderer – served from your WordPress installation (no CDN)
Chart.js chart renderer – served from your WordPress installation (no CDN)
markdown-it parser – bundled locally
Optional features that contact an external server (opt-in, off by default):
Two features can send diagram source to an external rendering server. Both are inactive until you explicitly enable, configure a server URL, and accept the in-plugin privacy notice:
PlantUML diagrams – PlantUML has no in-browser renderer, so the source of each “`plantuml block is sent to a PlantUML/Kroki server to produce the image. Default server (configurable, or self-hostable): https://www.plantuml.com/plantuml
Service: PlantUML – https://plantuml.com/
Server-side Mermaid rendering (Kroki) – an optional mode that pre-renders Mermaid diagrams on a Kroki server for faster first paint. When enabled, the Mermaid source is sent to the configured server.
Default server (configurable, or self-hostable): https://kroki.io
Service: Kroki – https://kroki.io/
To keep diagram source private you can point either feature at a server you self-host. When both options are left in their default (disabled) state, no diagram data or any other content leaves your site.
Pro license validation (only if you activate a Pro license key):
This Free plugin ships the shared license-gating code used by the separate Pro plugin. If you install the Pro plugin and enter a license key, activating, deactivating, or periodically re-validating that key sends the license key (no diagram or post content) to the license server:
Without the Pro plugin and an activated license key, no request is made to this endpoint.
Privacy & Security Benefits (default configuration): * No tracking, analytics, or data collection * No data is transmitted to external servers unless you opt in to PlantUML or server-side Mermaid rendering, or activate a Pro license key * Works offline and in closed networks with the default settings
Privacy
This plugin does not collect any personal data, and with the default settings all processing happens locally on your server. If you opt in to PlantUML or server-side (Kroki) Mermaid rendering, the source text of those diagrams is sent to the rendering server you configure – choose a server you trust, or self-host one, for sensitive content. If you activate a Pro license key, the key is sent to the Lemon Squeezy license server to validate it.
Credits
Syntax highlighting: Shiki
Diagram rendering: Mermaid
Chart rendering: Chart.js
Markdown parsing: markdown-it
Developer Information
This section provides essential information for developers who want to extend or customize the plugin.
For complete API documentation, architecture diagrams, and customization examples, see: Developer Documentation on GitHub
Available Hooks and Filters
Actions:
gfmr_metadata_saved – Fired when code block metadata is saved Parameters: $post_id (int), $metadata (array)
Use case: Sync metadata with external services, logging
Filters:
gfmr_metadata_get_metadata – Filter retrieved metadata before use Parameters: $metadata (array), $post_id (int)
Use case: Custom language detection, metadata modification
gfmr_schema_data – Filter Schema.org JSON-LD data before output
Parameters: $schema (array), $post (WP_Post)
Use case: Add custom schema properties, author profiles
schema_auto_detect_type – Auto-detect article type (bool)
schema_include_author – Include author in schema (bool)
schema_include_publisher – Include publisher in schema (bool)
uninstall_remove_data – Remove plugin data on uninstall (bool, default false)
Plugin Development
This plu
See it in action
Screenshots & previews.
Block Editor - Add and edit Markdown in the block editor with live syntax highlightingSyntax Highlighting - Front-end code blocks with Shiki highlighting and a copy buttonMermaid Diagrams - Mermaid flowchart rendered from a fenced code block on the front endTables and Formatting - GitHub Flavored Markdown tables, text formatting, lists, and blockquotesMobile Rendering - Responsive Markdown output on mobile-width screensCode Block Settings - Theme selection and live preview in the plugin settings screenChart.js Data Visualization - Chart.js bar chart rendered from a chart fenced code blockMarkdown to Rendered Output - Raw Markdown alongside its polished WordPress rendering
02 / Source details
Gettingstarted.
Install from WordPress admin:
01Go to Plugins > Add New.
02Search for “Markdown Renderer for GitHub”.
03Click Install Now.
04Click Activate.
Install from a ZIP file:
05Go to Plugins > Add New > Upload Plugin.
06Upload the plugin ZIP file.
07Click Install Now.
08Click Activate.
First setup after activation:
09Open Markdown Renderer for GitHub > Manual in the WordPress admin menu.
10Read the Getting Started tab.
11Add a Markdown block to a post or page, or wrap Markdown in the [gfmr_markdown] shortcode.
12Preview the front-end page.
13Adjust the Code Block theme, Markdown style preset, Table of Contents, diagram, structured data, multilingual, or server-side rendering settings only when your site needs them.
03 / Source details
Frequently asked questions.
What should I do first after installation?
Open Markdown Renderer for GitHub > Manual, read the Getting Started tab, then create or edit a post with the Markdown block. Preview the front-end page and adjust the Code Block settings if needed.
How do I add Markdown content?
Use the Markdown block in the block editor. In the Classic editor, widgets, or templates, wrap Markdown in the [gfmr_markdown] enclosing shortcode. The shortcode renders through the same core pipeline as the block.
How do I add a note or warning callout?
Use the GitHub alert syntax: start a blockquote whose first line is > [!NOTE] , then write the body on the following quoted lines. [!TIP] , [!IMPORTANT] , [!WARNING] , and [!CAUTION] work the same way. The keyword must be alone on that first line, otherwise the block stays an ordinary blockquote.
What should I check if settings are not reflected?
Save the settings, clear page cache, CDN cache, browser cache, and any asset optimization cache. Then check a front-end post that actually contains a Markdown block or [gfmr_markdown] shortcode.
Can I use this with my theme or cache plugin?
Usually yes. If output looks stale or broken, temporarily disable cache, minification, defer, and combine settings. If styles still look wrong, test briefly with a default WordPress theme to isolate theme CSS conflicts.
Does this plugin send content to external services?
By default, no. Shiki, Mermaid, Chart.js, and markdown-it are bundled locally and served from your WordPress installation. Optional PlantUML and server-side Mermaid rendering can send diagram source to an external renderer only after you enable and configure those features. See Third Party Services for details.
What is the difference between the free and Pro versions?
The free plugin includes the main rendering features: GFM, Shiki, Mermaid, Chart.js, PlantUML, Table of Contents, structured data, multilingual options, and basic AI agent abilities. Pro is a separate, standalone plugin (it bundles all Free features) for advanced workflow features and priority support. You do not need Pro for the core rendering features.
What happens to my settings when I delete the plugin?
Nothing is removed by default: deleting the plugin leaves its settings, caches, and post metadata in the database, so reinstalling restores your configuration. If you want a clean removal, enable “Remove Data on Uninstall” on the General Settings tab before deleting the plugin. That option is off by default and cannot be undone once the plugin is deleted.
Where can I get support?
Free plugin usage questions and reproducible bugs should go to the WordPress.org support forum. Pro license, billing, contract, refund, and account questions should not be posted in the WordPress.org forum; use the support guidance shown inside the plugin admin screen.
What information should I include in a support request?
Include WordPress version, PHP version, plugin version, theme, affected feature, steps to reproduce, and relevant non-secret System Info from the plugin settings screen. Never share license keys, API keys, Application Passwords, tokens, cookies, or private account information.
Website LLMs.txt and LLMs-Full.txt Generator is an LLMs.txt generator and llms-full.txt generator for WordPress. It helps site owners generate, manage, preview, validate, and serve AI discovery files from published public content. Use it to create structured /llms.txt and optional /llms-full.txt end
EngageDock AI is a customizable floating contact widget for WordPress websites that want more leads and faster visitor communication. It helps small businesses turn website traffic into calls, texts, emails, and callback requests from one clean contact panel. Key Features: Click-to-Call – One tap ca
Altify AI is an auto ALT text and AI ALT text plugin for WordPress images. It helps generate descriptive image ALT text for accessibility and image SEO. Use bulk image ALT text tools for your Media Library, generate featured image ALT text automatically, and scale WooCommerce image ALT updates with
The Accepted Payment Methods plugin is a straightforward, lightweight solution that enhances your website by displaying visually appealing icons of the payment methods you accept. This plugin is ideal for a variety of websites, including e-commerce platforms, service-oriented websites, and informati
