remark-comments

remark-comments

This plugin parses custom Markdown syntax for Markdown source comments.

Syntax

You can write comments in the Markdown source this way:

Foo<--COMMENTS I am a comment COMMENTS-->bar

Everything between <--COMMENTS and COMMENTS--> will be absent from the output.

Installation

npm:

npm install remark-comments

Usage

Dependencies:

const unified = require('unified')
const remarkParse = require('remark-parse')
const stringify = require('rehype-stringify')
const remark2rehype = require('remark-rehype')

const remarkComments = require('remark-comments')

Usage:

unified()
  .use(remarkParse)
  .use(remarkComments)
  .use(remark2rehype)
  .use(stringify)

License

MIT © Zeste de Savoir