plugins.md

Plugins

remark is a Markdown processor powered by plugins part of the unified collective.

Table of Contents

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

List of Plugins

See awesome remark for the most awesome projects in the ecosystem. More plugins can be found on GitHub tagged with the remark-plugin topic.

Have a good idea for a new plugin? See Creating plugins below.

• remark-abbr — custom syntax for abbreviations (new node type, rehype compatible)
• remark-align — custom syntax to align text or blocks (new node types, rehype compatible)
• remark-attr — custom syntax to add attributes to markdown
• remark-autolink-headings — add GitHub-style links to headings
• remark-behead — increase or decrease heading depth
• remark-bookmarks – automatic link manager
• remark-bracketed-spans – custom syntax for id’s, classes, and data attributes to spans of text
• remark-breaks – support hard breaks without needing spaces (like on issues)
• remark-capitalize – transform all titles with title.sh
• remark-code-extra — Add to or transform the HTML output of code blocks (rehype compatible)
• remark-code-frontmatter — Extract frontmatter from markdown code blocks
• remark-code-screenshot – turn code blocks into carbon.now.sh screenshots
• remark-collapse — make a section collapsible
• remark-comment-config — configure remark with comments
• remark-comments — custom syntax to ignore things
• remark-containers — add custom containers
• remark-contributors — add a table of contributors
• remark-custom-blocks — custom syntax for custom blocks (new node types, rehype compatible)
• remark-defsplit — change links and images to references with separate definitions
• remark-disable-tokenizers — turn some or all remark’s tokenizers on or off
• remark-embed-images — embed local images as base64-encoded data URIs
• remark-emoji — transform Gemoji short-codes to emoji
• remark-emoji-to-gemoji — transform emoji to Gemoji short-codes
• remark-external-links — add target and rel attributes to external links
• remark-first-heading — replace the first heading in a document
• remark-fix-guillemets — support ASCII guillements (<<, >>) mapping them to HTML
• remark-frontmatter – support frontmatter (yaml, toml, and more)
• remark-gemoji — better support for Gemoji shortcodes
• remark-gemoji-to-emoji — transform Gemoji shortcodes to emoji
• remark-generic-extensions — custom syntax for the CommonMark generic directive extension
• remark-git-contributors — add a table of contributors based on Git history, options, and more
• remark-github — autolink references to commits, issues, pull-requests, and users
• remark-gitlab-artifact — download artifacts from GitLab projects to live alongside your docs
• remark-grid-tables — custom syntax to describe tables (rehype compatible)
• remark-graphviz — transform graphviz dot graphs to SVG
• remark-heading-gap — stringify with more blank lines between headings
• remark-highlight.js — highlight code blocks with highlight.js (rehype compatible)
• remark-html — stringify Markdown as HTML
• remark-html-emoji-image — transform emoji to images
• remark-html-katex — change inline and block math to equations with KaTeX
• remark-iframes — custom syntax to create iframes (new node type, rehype compatible)
• remark-images — add an improved image syntax
• remark-inline-links — change references and definitions to links and images
• remark-kbd — custom syntax for keyboard keys (new node type, rehype compatible)
• remark-kbd-plus — custom syntax for keyboard keys with plusses (new node type, rehype compatible)
• remark-license — add a license section
• remark-linkify-regex — change text matching a regex to links
• remark-lint — check Markdown code style
• remark-macro — support for block macros (new node types, rehype compatible)
• remark-man — stringify Markdown as man pages (roff)
• remark-math — custom syntax for math (new node types, rehype compatible)
• remark-mermaid — transform mermaid graphs to SVG
• remark-message-control — turn some or all messages on or off
• remark-metadata — add metadata about the processed file as front matter
• remark-midas — highlight CSS code blocks with midas (rehype compatible)
• remark-normalize-headings — make sure at most one top-level heading exists
• remark-openapi — transform links to local or remote OpenAPI definitions to tables
• remark-parse-yaml — parse YAML nodes and expose their value as parsedValue
• remark-ping — custom syntax for mentions with configurable existence check (new node type, rehype compatible)
• remark-react — “stringify” Markdown as React
• remark-react-codemirror — highlight code blocks for remark-react with CodeMirror
• remark-react-lowlight — highlight code blocks for remark-react with lowlight
• remark-redact — conceal text matching a regex
• remark-redactable — write plugins to redact content from a Markdown document, then restore it later
• remark-reference-links — transform links and images into references and definitions
• remark-rehype — transform to rehype
• remark-relative-links — change absolute URLs to relative ones
• remark-retext — transform to retext
• remark-ruby — add a custom syntax for ruby (furigana)
• remark-sectionize — wrap headings and subsequent content in section tags (new node type, rehype compatible)
• remark-shortcodes — custom syntax Wordpress- and Hugo-like shortcodes (new node type)
• remark-slug — add anchors to headings using GitHub’s algorithm
• remark-strip-badges — remove badges (such as shields.io)
• remark-strip-html — remove HTML
• remark-squeeze-paragraphs — remove empty paragraphs
• remark-sub-super — custom syntax for super- and subscript (new node types, rehype compatible)
• remark-terms — add customizable syntax for special terms and phrases
• remark-textr — transform text with Textr
• remark-title — check and add the document title
• remark-toc — add a table of contents
• remark-tree-sitter — highlight code blocks in Markdown files using Tree-sitter (rehype compatible)
• remark-unlink — remove all links, references, and definitions
• remark-unwrap-images — remove the wrapping paragraph for images
• remark-usage — add a usage example
• remark-utf8 — turn bolds, italics, and code into UTF-8 special characters
• remark-validate-links — check links to headings and files
• remark-vdom — “stringify” Markdown as VDOM
• remark-wiki-link — custom syntax for wiki links (rehype compatible)
• remark-yaml-config — configure remark with YAML

List of Presets

See npm search or github 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. 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

Have an idea for a plugin? Post it on spectrum or in ideas and make it happen!

To create a plugin, 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 make, and work from there. If you get stuck, spectrum, ideas, and issues are good places to get help.

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

Do not use the remark- prefix if the thing you create doesn’t work with remark().use(): it isn’t a “plugin” and will confuse users. If it works with mdast, use 'mdast-util-', if it works with any unist tree, use unist-util-, and if it works with virtual files, use vfile-.