From 5d13f8ec62c7c3de2963c33ddac36508727c1dae Mon Sep 17 00:00:00 2001 From: Titus Wormer Date: Wed, 26 Jun 2019 18:40:46 +0200 Subject: [PATCH] Update list of plugins --- doc/plugins.md | 85 ++++++++++++++++++++++++++++---------------------- 1 file changed, 47 insertions(+), 38 deletions(-) diff --git a/doc/plugins.md b/doc/plugins.md index 3ee083e6b..4a9acd7ec 100644 --- a/doc/plugins.md +++ b/doc/plugins.md @@ -2,7 +2,7 @@ # Plugins -**remark** is a markdown processor powered by plugins part of the [unified][] +**remark** is a Markdown processor powered by plugins part of the [unified][] [collective][]. ## Table of Contents @@ -22,9 +22,9 @@ More plugins can be found on GitHub tagged with the Have a good idea for a new plugin? See [Creating plugins][create] below. -* [`remark-abbr`](https://github.com/zestedesavoir/zmarkdown/tree/master/packages/remark-abbr) +* [`remark-abbr`](https://github.com/zestedesavoir/zmarkdown/tree/master/packages/remark-abbr#readme) — custom syntax for abbreviations (new node type, rehype compatible) -* [`remark-align`](https://github.com/zestedesavoir/zmarkdown/tree/master/packages/remark-align) +* [`remark-align`](https://github.com/zestedesavoir/zmarkdown/tree/master/packages/remark-align#readme) — custom syntax to align text or blocks (new node types, rehype compatible) * [`remark-attr`](https://github.com/arobase-che/remark-attr) — custom syntax to add attributes to markdown @@ -45,19 +45,19 @@ See [Creating plugins][create] below. – turn code blocks into carbon.now.sh screenshots * [`remark-collapse`](https://github.com/Rokt33r/remark-collapse) — make a section collapsible -* [`remark-comment-blocks`](https://github.com/remarkjs/remark-comment-blocks) - — wrap the document in a comment block * [`remark-comment-config`](https://github.com/remarkjs/remark-comment-config) — configure remark with comments -* [`remark-comments`](https://github.com/zestedesavoir/zmarkdown/tree/master/packages/remark-comments) +* [`remark-comments`](https://github.com/zestedesavoir/zmarkdown/tree/master/packages/remark-comments#readme) — custom syntax to ignore things -* [`remark-contributors`](https://github.com/hughsk/remark-contributors) +* [`remark-containers`](https://github.com/Nevenall/remark-containers) + — add custom containers +* [`remark-contributors`](https://github.com/remarkjs/remark-contributors) — add a table of contributors -* [`remark-custom-blocks`](https://github.com/zestedesavoir/zmarkdown/tree/master/packages/remark-custom-blocks) +* [`remark-custom-blocks`](https://github.com/zestedesavoir/zmarkdown/tree/master/packages/remark-custom-blocks#readme) — custom syntax for custom blocks (new node types, rehype compatible) * [`remark-defsplit`](https://github.com/remarkjs/remark-defsplit) — change links and images to references with separate definitions -* [`remark-disable-tokenizers`](https://github.com/zestedesavoir/zmarkdown/tree/master/packages/remark-disable-tokenizers) +* [`remark-disable-tokenizers`](https://github.com/zestedesavoir/zmarkdown/tree/master/packages/remark-disable-tokenizers#readme) — turn some or all remark’s tokenizers on or off * [`remark-embed-images`](https://github.com/remarkjs/remark-embed-images) — embed local images as base64-encoded data URIs @@ -69,54 +69,59 @@ See [Creating plugins][create] below. — add target and rel attributes to external links * [`remark-first-heading`](https://github.com/laat/remark-first-heading) — replace the first heading in a document -* [`remark-fix-guillemets`](https://github.com/zestedesavoir/zmarkdown/tree/master/packages/remark-fix-guillemets) +* [`remark-fix-guillemets`](https://github.com/zestedesavoir/zmarkdown/tree/master/packages/remark-fix-guillemets#readme) — support ASCII guillements (`<<`, `>>`) mapping them to HTML * [`remark-frontmatter`](https://github.com/remarkjs/remark-frontmatter) – support frontmatter (yaml, toml, and more) * [`remark-gemoji`](https://github.com/remarkjs/remark-gemoji) - — better support for Gemoji short-codes + — better support for Gemoji shortcodes * [`remark-gemoji-to-emoji`](https://github.com/jackycute/remark-gemoji-to-emoji) - — transform Gemoji short-codes to emoji + — transform Gemoji shortcodes to emoji * [`remark-generic-extensions`](https://github.com/medfreeman/remark-generic-extensions) - — custom syntax for the commonmark generic directive extension -* [`remark-git-contributors`](https://github.com/vweevers/remark-git-contributors) + — custom syntax for the CommonMark generic directive extension +* [`remark-git-contributors`](https://github.com/remarkjs/remark-git-contributors) — add a table of contributors based on Git history, options, and more * [`remark-github`](https://github.com/remarkjs/remark-github) - — add support for autolink references like in issues, PRs, and comments + — autolink references to commits, issues, pull-requests, and users * [`remark-gitlab-artifact`](https://github.com/temando/remark-gitlab-artifact) — download artifacts from GitLab projects to live alongside your docs -* [`remark-grid-tables`](https://github.com/zestedesavoir/zmarkdown/tree/master/packages/remark-grid-tables) +* [`remark-grid-tables`](https://github.com/zestedesavoir/zmarkdown/tree/master/packages/remark-grid-tables#readme) — custom syntax to describe tables (rehype compatible) * [`remark-graphviz`](https://github.com/temando/remark-graphviz) — transform [graphviz](https://www.graphviz.org) dot graphs to SVG * [`remark-heading-gap`](https://github.com/remarkjs/remark-heading-gap) - — stringify with more spacing between headings + — stringify with more blank lines between headings * [`remark-highlight.js`](https://github.com/remarkjs/remark-highlight.js) — highlight code blocks with [highlight.js](https://github.com/isagalaev/highlight.js) (rehype compatible) * [`remark-html`](https://github.com/remarkjs/remark-html) - — stringify markdown as HTML + — stringify Markdown as HTML * [`remark-html-emoji-image`](https://github.com/jackycute/remark-html-emoji-image) — transform emoji to images -* [`remark-html-katex`](https://github.com/rokt33r/remark-math/blob/master/packages/remark-html-katex/readme.md) +* [`remark-html-katex`](https://github.com/Rokt33r/remark-math/tree/master/packages/remark-html-katex#readme) — change inline and block math to equations with [KaTeX](https://github.com/Khan/KaTeX) -* [`remark-iframes`](https://github.com/zestedesavoir/zmarkdown/tree/master/packages/remark-iframes) +* [`remark-iframes`](https://github.com/zestedesavoir/zmarkdown/tree/master/packages/remark-iframes#readme) — custom syntax to create iframes (new node type, rehype compatible) +* [`remark-images`](https://github.com/remarkjs/remark-images) + — add an improved image syntax * [`remark-inline-links`](https://github.com/remarkjs/remark-inline-links) — change references and definitions to links and images -* [`remark-kbd`](https://github.com/zestedesavoir/zmarkdown/tree/master/packages/remark-kbd) +* [`remark-kbd`](https://github.com/zestedesavoir/zmarkdown/tree/master/packages/remark-kbd#readme) — custom syntax for keyboard keys (new node type, rehype compatible) +* [`remark-kbd-plus`](https://github.com/twardoch/remark-kbd-plus) + — custom syntax for keyboard keys with plusses (new node type, rehype + compatible) * [`remark-license`](https://github.com/remarkjs/remark-license) — add a license section * [`remark-linkify-regex`](https://gitlab.com/staltz/remark-linkify-regex) — change text matching a regex to links * [`remark-lint`](https://github.com/remarkjs/remark-lint) - — check markdown code style + — check Markdown code style * [`remark-macro`](https://github.com/dimerapp/remark-macro) — support for block macros (new node types, rehype compatible) * [`remark-man`](https://github.com/remarkjs/remark-man) - — stringify markdown as man pages (roff) -* [`remark-math`](https://github.com/rokt33r/remark-math) + — stringify Markdown as man pages (roff) +* [`remark-math`](https://github.com/Rokt33r/remark-math) — custom syntax for math (new node types, rehype compatible) * [`remark-mermaid`](https://github.com/temando/remark-mermaid) — transform [mermaid](https://mermaidjs.github.io/) graphs to SVG @@ -124,44 +129,46 @@ See [Creating plugins][create] below. — turn some or all messages on or off * [`remark-metadata`](https://github.com/temando/remark-metadata) — add metadata about the processed file as front matter -* [`remark-midas`](https://github.com/ben-eb/remark-midas) +* [`remark-midas`](https://github.com/remarkjs/remark-midas) — highlight CSS code blocks with [midas](https://github.com/ben-eb/midas) (rehype compatible) -* [`remark-normalize-headings`](https://github.com/eush77/remark-normalize-headings) +* [`remark-normalize-headings`](https://github.com/remarkjs/remark-normalize-headings) — make sure at most one top-level heading exists * [`remark-openapi`](https://github.com/temando/remark-openapi) — transform links to local or remote OpenAPI definitions to tables * [`remark-parse-yaml`](https://github.com/landakram/remark-parse-yaml) — parse YAML nodes and expose their value as `parsedValue` -* [`remark-ping`](https://github.com/zestedesavoir/zmarkdown/tree/master/packages/remark-ping) +* [`remark-ping`](https://github.com/zestedesavoir/zmarkdown/tree/master/packages/remark-ping#readme) — custom syntax for mentions with configurable existence check (new node type, rehype compatible) -* [`remark-react`](https://github.com/mapbox/remark-react) - — “stringify” markdown as [React](https://github.com/facebook/react) +* [`remark-react`](https://github.com/remarkjs/remark-react) + — “stringify” Markdown as [React](https://github.com/facebook/react) * [`remark-react-codemirror`](https://github.com/craftzdog/remark-react-codemirror) — highlight code blocks for **remark-react** with [CodeMirror](https://codemirror.net) -* [`remark-react-lowlight`](https://github.com/bebraw/remark-react-lowlight) +* [`remark-react-lowlight`](https://github.com/inlinestyle/remark-react-lowlight) — highlight code blocks for **remark-react** with [lowlight](https://github.com/wooorm/lowlight) * [`remark-redact`](https://github.com/seafoam6/remark-redact) — conceal text matching a regex * [`remark-redactable`](https://github.com/code-dot-org/remark-redactable) - — write plugins to redact content from a markdown document, + — write plugins to redact content from a Markdown document, then restore it later * [`remark-reference-links`](https://github.com/remarkjs/remark-reference-links) - — change links and images to references and definitions + — transform links and images into references and definitions * [`remark-rehype`](https://github.com/remarkjs/remark-rehype) — transform to [rehype](https://github.com/rehypejs/rehype) * [`remark-relative-links`](https://github.com/zslabs/remark-relative-links) — change absolute URLs to relative ones * [`remark-retext`](https://github.com/remarkjs/remark-retext) — transform to [retext](https://github.com/retextjs/retext) +* [`remark-ruby`](https://github.com/laysent/remark-ruby) + — add a custom syntax for ruby (furigana) * [`remark-sectionize`](https://github.com/jake-low/remark-sectionize) — wrap headings and subsequent content in section tags (new node type, rehype compatible) * [`remark-shortcodes`](https://github.com/djm/remark-shortcodes) — custom syntax Wordpress- and Hugo-like shortcodes (new node type) * [`remark-slug`](https://github.com/remarkjs/remark-slug) - — add slugs to headings + — add anchors to headings using GitHub’s algorithm * [`remark-strip-badges`](https://github.com/remarkjs/remark-strip-badges) — remove badges (such as `shields.io`) * [`remark-strip-html`](https://github.com/craftzdog/remark-strip-html) @@ -170,20 +177,22 @@ See [Creating plugins][create] below. — remove empty paragraphs * [`remark-sub-super`](https://github.com/zestedesavoir/zmarkdown/tree/master/packages/remark-sub-super) — custom syntax for super- and subscript (new node types, rehype compatible) -* [`remark-swagger`](https://github.com/yoshuawuyts/remark-swagger) - — add a swagger specification -* [`remark-textr`](https://github.com/denysdovhan/remark-textr) +* [`remark-terms`](https://github.com/Nevenall/remark-terms) + — add customizable syntax for special terms and phrases +* [`remark-textr`](https://github.com/remarkjs/remark-textr) — transform text with [`Textr`](https://github.com/shuvalov-anton/textr) * [`remark-title`](https://github.com/RichardLitt/remark-title) — check and add the document title * [`remark-toc`](https://github.com/remarkjs/remark-toc) — add a table of contents * [`remark-tree-sitter`](https://github.com/samlanning/remark-tree-sitter) - — highlight code blocks in markdown files using + — highlight code blocks in Markdown files using [Tree-sitter](https://tree-sitter.github.io/tree-sitter/) (rehype compatible) * [`remark-unlink`](https://github.com/remarkjs/remark-unlink) — remove all links, references, and definitions +* [`remark-unwrap-images`](https://github.com/remarkjs/remark-unwrap-images) + — remove the wrapping paragraph for images * [`remark-usage`](https://github.com/remarkjs/remark-usage) — add a usage example * [`remark-utf8`](https://github.com/Swizec/remark-utf8) @@ -191,7 +200,7 @@ See [Creating plugins][create] below. * [`remark-validate-links`](https://github.com/remarkjs/remark-validate-links) — check links to headings and files * [`remark-vdom`](https://github.com/remarkjs/remark-vdom) - — “stringify” markdown as [VDOM](https://github.com/Matt-Esch/virtual-dom/) + — “stringify” Markdown as [VDOM](https://github.com/Matt-Esch/virtual-dom/) * [`remark-wiki-link`](https://github.com/landakram/remark-wiki-link) — custom syntax for wiki links (rehype compatible) * [`remark-yaml-config`](https://github.com/remarkjs/remark-yaml-config)