plugins.md

Plugins

remark is an ecosystem of plugins.

See tools built with remark ».

Table of Contents

• List of Plugins
• List of Presets
• List of Utilities
• Using plugins
• Creating plugins

List of Plugins

Have a good idea for a new plugin? Let’s chat and make it happen!

• remark-abbr — Custom syntax to handle abbreviations, custom mdast inline node type abbr. Rehype compatible (<abbr title="bar">foo</abbr>)
• remark-align — Custom syntax to handle text/block alignment, custom mdast block node type CenterAligned, RightAligned. Rehype compatible (wraps in divs with alignment as configurable CSS class)
• remark-attr — Add support for custom attributes to markdown
• remark-autolink-headings — Automatically add GitHub style links to headings
• remark-bookmarks – Link manager for Markdown files
• remark-bracketed-spans – Add an id, classes, and data attributes to <span> tags in markdown
• remark-breaks – Breaks support, without needing spaces
• remark-collapse — Make a section collapsible
• remark-comment-blocks — Wrap Markdown with a comment block
• remark-comment-config — Configure remark with comments
• remark-comments — Configurable custom syntax to ignore parts of the Markdown input
• remark-contributors — Inject a given table of contributors
• remark-custom-blocks — Configurable custom syntax to parse custom blocks, creating new mdast node types. Rehype compatible
• remark-defsplit — Extract inline link and image destinations as separate definitions
• remark-disable-tokenizers — Disable any or all remark’s blockTokenizers and inlineTokenizers
• remark-embed-images — Embed images with data: URIs, inlining base64-encoded sources
• remark-emoji — Transform unicode emoji to Gemoji shortcodes
• remark-emoji-to-gemoji — Transform Gemoji shortcodes to unicode emoji
• remark-external-links — Automatically adds the target and rel attributes to external links
• remark-first-heading — Replacing the first heading in a document
• remark-fix-guillemets — For weird typographic reasons, this fixes <<a>> being parsed as < + html tag <a> + > and instead replaces this with text <<a>>
• remark-frontmatter – Frontmatter (yaml, toml, and more) support
• remark-gemoji — Gemoji short-code support in remark
• remark-gemoji-to-emoji — Transform Gemoji shortcodes to Unicode emoji
• remark-generic-extensions — Commonmark generic directive extension
• remark-github — Auto-link references like in GitHub issues, PRs, and comments
• remark-gitlab-artifact — Download artifacts from GitLab projects to live alongside your Markdown
• remark-grid-tables — Custom Markdown syntax to describe tables. Rehype compatible
• remark-graphviz — Replace dot graphs with rendered SVGs
• remark-heading-gap — Adjust the gap between headings
• remark-highlight.js — Highlight code blocks in Markdown files with highlight.js
• remark-html — Compile Markdown to HTML documents
• remark-html-emoji-image — Transform unicode emoji to HTML images
• remark-html-katex — Transform math inline and block nodes to styled HTML equations with KaTeX
• remark-iframes — Custom syntax with fully configurable iframe providers, following a whitelist approach. Rehype compatible
• remark-inline-links — Transform references and definitions to normal links and images
• remark-inline-math — Inline math support
• remark-kbd — Custom syntax, parses ||foo|| into a new mdast inline node type kbd. Rehype compatible (<kbd>foo</kbd>)
• remark-license — Add a license section
• remark-lint — Markdown code style linter
• remark-man — Compile Markdown to Man pages (roff)
• remark-math — Math inline and block support
• remark-mermaid — Replace mermaid graphs with rendered SVGs
• remark-message-control — Enable, disable, and ignore messages
• remark-metadata — Add metadata about the processed file as front matter
• remark-midas — Highlight CSS in Markdown files with midas
• remark-normalize-headings — Ensure at most one top-level heading is in the document
• remark-openapi — Convert links to local or remote OpenAPI definition to tables with summaries of all paths
• remark-parse-yaml — Parse YAML blocks into structured data
• remark-ping — Custom syntax, parses @user, @**first last**, configurable existence check. Rehype compatible
• remark-react — Compile Markdown to React
• remark-react-codemirror — Syntax highlighting for remark-react through CodeMirror
• remark-react-lowlight — Syntax highlighting for remark-react through lowlight
• remark-reference-links — Transform links and images to references and definitions
• remark-rehype — rehype support
• remark-retext — retext support
• remark-rewrite-headers — Change heading levels
• remark-shortcodes — Parses custom Wordpress/Hugo-like shortcodes inside your Markdown
• remark-slug — Add slugs to headings
• remark-strip-badges — Remove badges (such as shields.io)
• remark-strip-html — Remove html formatting
• remark-squeeze-paragraphs — Remove empty paragraphs
• remark-sub-super — Custom syntax to parse subscript and superscript. Rehype compatible (using <sub> and <sup>)
• remark-swagger — Insert a swagger specification
• remark-textr — Textr, a modular typographic framework
• remark-title — Check and inject the title of a markdown as the first element.
• remark-toc — Generate a Table of Contents (TOC) for Markdown files
• remark-unlink — Remove all links, references and definitions
• remark-usage — Add a usage example to your readme
• remark-validate-links — Validate links point to existing headings and files
• remark-vdom — Compile Markdown to VDOM
• remark-wiki-link — Parse and render wiki links
• remark-yaml-annotations — Extend Markdown with YAML-based annotation syntax
• remark-yaml-config — Configure remark with YAML

List of Presets

See npm search for available and often inspirational presets.

List of Utilities

See MDAST for a list of utilities for working with the syntax tree. See unist for other utilities which work with MDAST nodes, too.

And finally, see vfile for a list of utilities working with virtual files.

Using plugins

To use a plugin programmatically, invoke the use() function.

To use plugin with remark-cli, pass a --use flag or specify it in a configuration file.

Creating plugins

First, read up on the concept of plugins. Then, read the guide on “Creating a plugin with unified”. Finally, take one of existing plugins, which looks similar to what you’re about to do, and work from there. If you get stuck, issues and Gitter are good places to get help.

You should pick a name prefixed by 'remark-', such as remark-lint.

Note that, if the thing you create cannot be given to remark().use(), it isn’t a “plugin”. Don’t use the remark- prefix as that could confuse users. If it works with the HAST tree, use 'mdast-util-', if it works with any Unist tree, use unist-util-, if it works with virtual files, use vfile-.