=== Markdown Renderer for GitHub === Contributors: wakalab Donate link: https://wakalab.dev/ Tags: markdown, github, gfm, syntax-highlighting, mermaid Requires at least: 6.0 Tested up to: 6.9 Requires PHP: 8.1 Stable tag: 1.7.13 License: GPLv2 or later License URI: https://www.gnu.org/licenses/gpl-2.0.html Transform your WordPress content with beautiful GitHub Flavored Markdown rendering, syntax highlighting, and interactive diagrams. == Description == Markdown Renderer for GitHub transforms your WordPress content with beautiful GitHub Flavored Markdown (GFM) rendering. Perfect for technical blogs, documentation sites, and any content that needs professional code presentation. **Key Features:** 🎨 **Beautiful Syntax Highlighting** * Powered by Shiki - the same syntax highlighter used by VS Code * Support for 100+ programming languages * Multiple beautiful themes (GitHub Light/Dark, VS Code themes, and more) * Automatic language detection 📊 **Mermaid Diagram Support** * Create flowcharts, sequence diagrams, and more * Professional diagram rendering * Interactive zoom functionality * Error handling with user-friendly messages ✨ **GitHub Flavored Markdown** * Tables, task lists, strikethrough * Automatic URL linking * Footnotes support * 100% compatible with GitHub markdown 📋 **Copy Button Feature** * One-click code copying * GitHub-style user experience * Full accessibility support * Mobile-friendly design ⚡ **Performance Optimized** * Asset lazy loading * Minimal performance impact * CDN-friendly architecture * Optimized for WordPress 🌍 **Developer Friendly** * Clean, semantic HTML output * Extensive hooks and filters * Translation ready (i18n) * WordPress coding standards **Perfect for:** * Technical blogs and tutorials * Documentation websites * Code portfolios * Educational content * API documentation * Developer resources == Installation == 1. Upload the plugin files to the `/wp-content/plugins/markdown-renderer-for-github` directory, or install the plugin through the WordPress plugins screen directly. 2. Activate the plugin through the 'Plugins' screen in WordPress. 3. Start using the Markdown block in the Gutenberg editor, or wrap your content with `[gfm-renderer]` shortcode. == Frequently Asked Questions == = What is GitHub Flavored Markdown? = GitHub Flavored Markdown (GFM) is an extension of standard Markdown that includes features like tables, task lists, syntax highlighting, and automatic URL linking. It's the same format used on GitHub.com. = Which programming languages are supported for syntax highlighting? = GitHub Flavored Markdown Renderer supports 100+ programming languages including JavaScript, Python, PHP, Java, C++, HTML, CSS, SQL, and many more. The highlighting is powered by Shiki, the same engine used by VS Code. = Can I create diagrams with this plugin? = Yes! You can create beautiful diagrams using Mermaid syntax, including: * Flowcharts * Sequence diagrams * Class diagrams * State diagrams * Gantt charts * And more = Is the plugin mobile-friendly? = Absolutely! All features including syntax highlighting, diagrams, and the copy button work perfectly on mobile devices. = Does this affect my site's performance? = GitHub Flavored Markdown Renderer is designed for minimal performance impact with smart asset lazy loading and optimized code. Assets are only loaded when needed, and the plugin adds less than 100KB to your site. = Can I customize the appearance? = Yes, the plugin provides CSS variables and hooks for customization. You can easily match your theme's design. = Is it translation ready? = Yes, the plugin is fully internationalized and translation ready. Japanese translation is included. = How do I add Markdown content? = You can use the dedicated "Markdown" block in the Gutenberg editor, or wrap your content with the `[gfm-renderer]` shortcode in classic editor. = Do I need coding knowledge to use this plugin? = Not at all! The plugin works with standard Markdown syntax that's easy to learn. The Gutenberg block provides a user-friendly interface with live preview. = Will this work with my theme? = Yes, GitHub Flavored Markdown Renderer is designed to work with any properly coded WordPress theme. The styling is designed to integrate seamlessly with your site's design. == Screenshots == 1. **Gutenberg Block Integration** - Easy-to-use Markdown block in the WordPress block editor with live preview 2. **Beautiful Syntax Highlighting** - Professional code presentation with copy button functionality and 100+ language support 3. **Interactive Mermaid Diagrams** - Create flowcharts, sequence diagrams, and more with zoom functionality 4. **GitHub-Style Tables & Formatting** - Perfect rendering of tables, task lists, and other GFM features 5. **Mobile-Responsive Design** - All features work seamlessly across desktop, tablet, and mobile devices 6. **Admin Settings** - Simple configuration options for themes and performance optimization == Changelog == = 1.7.13 = * Add automatic changelog sync from changelog.txt to readme.txt * WordPress互換性テストスイートを共通ライブラリで統合 * Resolve code highlighting rendering issues with theme mismatch = 1.7.12 = * PHPCSに加えてPHPStanを導入 * Implement WordPress.org compatibility auto-update * Add memory limit to PHPStan commands in scripts = 1.7.11 = * Apply light theme background color and set system theme as default = 1.7.10 = * Prevent dev environment data loss during E2E test resets * Remove color:revert rule in copy-button.css that broke Shiki highlighting * Resolve merge conflict in scripts/docker.sh = 1.7.9 = * Remove color:revert rules that broke Shiki syntax highlighting = 1.7.8 = * Parallelize CI tasks and optimize Docker readiness checks * Add slug parameter to Codecov upload action * Stabilize E2E tests by improving Docker environment and Mermaid detection = 1.7.7 = * Fix editor preview visibility for code blocks and Mermaid diagrams * E2E test timeout for empty code blocks and Mermaid-only content = 1.7.6 = * Fix editor preview visibility for code blocks and Mermaid diagrams = 1.7.5 = * Fix editor preview display for Shiki and Mermaid = 1.7.4 = * Stabilize Mermaid rendering in editor preview = 1.7.3 = * Improve Playwright browser cache in E2E tests * Prevent double-nested HTML wrapper in editor preview = 1.7.2 = * Stabilize Mermaid/Shiki rendering in editor preview * Clean up security audit temporary result files = 1.7.0 = * Add commit-language setting for English commit messages * Add i18n workflow for translate.wordpress.org * Fix Mermaid User Journey diagram not rendering in editor * WordPress 6.8+ iframe compatibility and CI optimization * Update readme.txt and changelog for WordPress.org i18n = 1.6.0 = * Convert Japanese comments to English for WordPress.org compliance = 1.5.0 = * Add Codecov coverage upload to CI/CD pipeline * Integrate JavaScript UI with WordPress translation system * Add support for Mermaid State Diagram with multiple syntax patterns * Add comprehensive E2E tests for Mermaid State Diagram rendering * Optimize GitHub Actions for faster PR checks * Add block-registry to test bootstrap for full coverage * Fix E2E test script mismatch and missing package-lock.json * Correct PHPUnit coverage configuration and namespace consistency * Enable Mermaid classDef styling in editor preview * Convert changelog to English and add language rules * Add post-release operations and monitoring guides * Strengthen unit tests * Add JavaScript unit tests for assets/js modules * Update changelog and gitignore = 1.4.0 = * Add Schema.org JSON-LD structured markup generation * Optimize conditional loading of KaTeX math library * Enable full-width display for GFM rendered content * Improve regression test quality with GFM rendering auto-detection * Add PHP 8.3/8.4 support to CI/CD pipeline * Add internationalization support for Gutenberg block editor * Improve performance by parallelizing PHP syntax checks * Fix Mermaid classDef styling not rendering in editor preview * Fix Mermaid v10+ syntax normalization for State Diagram * Add gitGraph detection to Gutenberg block editor * Fix multiple Mermaid diagram types not rendering on post display * Fix test stubs and Playwright authentication paths * Reorganize and restructure documentation * Complete comprehensive test content for GFM syntax and Mermaid diagrams * Enhance technical documentation with API specs, architecture diagrams, and customization guide * Add comprehensive E2E test suite for Mermaid State Diagram * Add E2E tests for Mermaid classDef styling * Strengthen backend test cases * Add detailed compatibility and performance tests * Organize temporary directory management and cleanup functionality = 1.3.9 = * Stabilize Mermaid diagram sizing * Simplify release flow and integrate changelog auto-generation = 1.3.8 = * Release process improvements = 1.3.7 = * Completely removed Plugin Update Checker (now using WordPress.org standard update system) * Added CI environment detection and strict mode to test scripts = 1.3.6 = * Completely removed Plugin Update Checker * Added CI environment detection and strict mode to test scripts == Upgrade Notice == = 1.7.0 = Added i18n workflow for translate.wordpress.org and fixed Mermaid User Journey rendering in editor. = 1.6.0 = Improved WordPress.org compliance and internationalization support. All users are recommended to upgrade. = 1.5.0 = New Mermaid State Diagram support and JavaScript UI translation integration. = 1.4.0 = Schema.org structured data support and improved rendering performance. = 1.0.0 = First official release with GitHub Flavored Markdown rendering. == Technical Requirements == * WordPress 6.0 or higher * PHP 8.1 or higher * Modern browser with JavaScript enabled * Recommended: 128MB+ PHP memory limit == 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. **Compressed File Source Code:** * **build/index.js**: WordPress Block Editor integration code * Source: blocks/markdown/src/ folder * Build: npm run build **Source Code Access:** * **GitHub Repository**: https://github.com/wakalab/markdown-renderer-for-github * **License**: GPL v2 or later * **Development Branch**: main **Build Instructions:** 1. Install Node.js 18+ 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 == This plugin operates entirely self-contained and does **NOT** use any external third-party services. **Complete Local Operation:** * All JavaScript libraries are bundled locally within the plugin * Shiki syntax highlighter - served from your WordPress installation (no CDN) * Mermaid diagram renderer - served from your WordPress installation (no CDN) * No external API calls or network requests are made **Privacy & Security Benefits:** * No data is transmitted to external servers * No tracking, analytics, or data collection * No external dependencies that could compromise your site * GDPR compliant by design * Works offline and in closed networks All functionality is fully self-contained within your WordPress installation with no external service dependencies. == Privacy == This plugin does not collect any personal data. All processing is done locally on your server. == Credits == * Syntax highlighting: [Shiki](https://shiki.style/) * Diagram rendering: [Mermaid](https://mermaid.js.org/) * Markdown parsing: [markdown-it](https://markdown-it.github.io/) == 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](https://github.com/wakalab/markdown-renderer-for-github/tree/main/docs) = 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 = PHP Constants = * `GFMR_PLUGIN_FILE` - Plugin main file path * `GFMR_SLUG` - Plugin slug ('markdown-renderer-for-github') * `GFMR_URI` - Plugin URL * `GFMR_PATH` - Plugin directory path * `GFMR_PLUGIN_PATH` - Plugin directory name (relative) * `GFMR_PLUGIN_BASENAME` - Plugin basename * `GFMR_ASSETS_PATH` - Assets directory URL = JavaScript Global Objects = * `wpGfmConfig` - Plugin configuration object * `wpGfmRenderer` - Core rendering API (processCodeBlocks, renderContent, initialize) * `wpGfmHighlighter` - Highlighter wrapper instance * `wpGfmShikiHighlighter` - Actual Shiki highlighter instance * `wpGfmUnifiedHighlight(code, lang, options)` - Unified highlight function * `wpGfmSwitchTheme(newTheme)` - Theme switching function ('light', 'dark', 'system') * `wpGfmRenderDiagram(content, element, options)` - Diagram rendering function = Settings Option = Option name: `gfmr_theme_settings` Available keys: * `theme` - Theme setting ('light', 'dark', 'system') * `schema_enabled` - Enable Schema.org JSON-LD output (bool) * `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) = Plugin Development = This plugin follows WordPress coding standards and provides clean, semantic HTML output. **Detailed Documentation:** For complete documentation including full API reference with code examples, architecture diagrams (Mermaid), step-by-step customization guides, and CSS class reference, visit: [GitHub Developer Documentation](https://github.com/wakalab/markdown-renderer-for-github/tree/main/docs)