jonschlinkert/remarkable
Remarkable
Remarkable is an extensible Markdown parser library that implements the CommonMark specification and supports GitHub Flavored Markdown through configurable rule presets. Its core architecture separates parsing into distinct inline and block rule pipelines, enabling targeted customization of text-level and structural syntax while maintaining consistent behavior across standard Markdown features.
The parser is built around a plugin-based rule system where individual syntax rules can be toggled, extended, or replaced by external plugins. A preset configuration system allows users to switch between strict CommonMark, full GFM, or custom rule bundles, while a typographic replacement engine post-processes rendered text to substitute plain punctuation with typographic equivalents. The library also exposes a syntax highlighting hook on fenced code blocks for integration with external highlighting libraries.
Beyond its core parsing capabilities, Remarkable provides automatic URL linking, extended syntax support for tables, footnotes, definition lists, and abbreviations, and configurable typographic enhancements. The documentation covers installation, preset switching, and plugin loading through chained methods for custom parsing and rendering behavior.
Features
- Markdown Renderers - Converts Markdown text into HTML with support for CommonMark, extensions, and syntax plugins.
- CommonMark Compliant Parsers - Implements the CommonMark specification for consistent Markdown parsing and HTML rendering.
- Plugin-Based Syntax Extensions - Loads third-party or custom plugins to add new syntax rules or transform output.
- Markdown-to-HTML Transpilers - Parses Markdown text and outputs HTML using a configurable parser with syntax extensions.
- Markdown Parsers - Provides an extensible Markdown parser implementing CommonMark with plugin-based syntax rules and configurable rendering.
- Markdown to HTML Converters - Converts Markdown text into HTML output using a configurable parser supporting CommonMark and GFM.
- Parsing Pipeline Plugins - Loads external plugins through a chained method to add custom parsing or rendering behavior.
- Plugin-Based Architectures - Composes parsing and rendering from individually toggleable rules that can be extended by plugins.
- Markdown Parser Extensions - Built around a plugin-based rule system where inline and block syntax rules can be toggled, extended, or replaced.
- GFM Presets - Ships a preset configuration that enables GitHub Flavored Markdown syntax through toggleable rule bundles.
- Clickable Link Detections - Automatically converts plain URLs in Markdown content into clickable anchor links.
- Extended Syntax Renderers - Renders extended Markdown syntax including tables, footnotes, definition lists, and abbreviations.
- Typographic Enhancement - Ships a configurable engine that replaces plain punctuation with typographic equivalents like smart quotes and dashes.
- Syntax Rule Presets - Provides predefined rule configurations for switching between CommonMark, GFM, or custom presets.
- Individual Rule Toggles - Allows fine-grained control over which Markdown syntax rules are active during parsing.
- Inline and Block Rule Pipelines - Separates parsing into distinct inline and block rule pipelines for targeted customization.
- Markdown and Syntax Highlighting - Exposes a syntax highlighting hook on fenced code blocks for integration with external highlighting libraries.
- Code Block Highlighting Hooks - Provides a callback hook on fenced code blocks for delegating syntax highlighting to external libraries.
- Syntax Highlighting Integrations - Applies syntax highlighting to code blocks by integrating with external highlighter libraries.
