Home
Welcome to the Apex documentation wiki! Apex is a unified Markdown processor that combines the best features from CommonMark, GitHub Flavored Markdown (GFM), MultiMarkdown, Kramdown, and Marked.
- Getting Started - Your first steps with Apex
- Installation - How to build and install Apex
- Usage - Basic usage examples
- Syntax - Complete syntax reference for unified mode
- Modes - Understanding processor modes
- Command Line Options - All CLI flags explained
-
Multi-file Documents - Combining multiple files with
--combine,--mmd-merge, and includes -
Metadata Transforms - Transform metadata values with
[%key:transform] - Integrating with Pandoc - Use Apex with Pandoc for DOCX, PDF, and more
- Header IDs - How header IDs are generated
- C API - Programmatic API documentation
- Xcode Integration - Using Apex in Xcode projects
- Examples - Practical usage examples
- Troubleshooting - Common issues and solutions
- Credits - Acknowledgments and links to related projects
- Plugins - Plugin system, examples, and recipes
- Filters - AST filters (Pandoc-style JSON), examples, and usage
Apex is a fast, C-based Markdown processor that supports multiple compatibility modes:
- CommonMark - Pure CommonMark specification
- GFM - GitHub Flavored Markdown
- MultiMarkdown - MultiMarkdown compatibility
- Kramdown - Kramdown compatibility
- Unified - All features enabled (default)
- Multiple processor modes for compatibility
- Rich syntax extensions (tables, footnotes, math, wiki links, etc.)
- Automatic header ID generation
- Relaxed tables (no separator rows required)
- Critic Markup support
- File includes and transclusion
- Metadata blocks and variables (see Metadata Transforms)
- Smart typography
- Pretty-printed HTML output
# Convert a markdown file
apex document.md > output.html
# Use unified mode (all features)
apex --mode unified document.md
# Generate standalone HTML document
apex document.md --standalone --title "My Document"For more information, see the Getting Started guide.