README.md

remark-inserted

This plugin parses custom Markdown syntax to handle text insertions like ++cats are awesome++. It adds a new node type to the mdast produced by remark: Mark

If you are using rehype, the stringified HTML result will be <mark>.

Syntax

It's cool how ++cats++ are super awesome.

AST (see mdast specification)

Mark (Parent) represents a reference to a user.

interface Mark <: Parent {
  type: "Mark";
}

For example, the following markdown:

++cats++

Yields:

{
  type: 'mark',
  children: [{
    type: 'text',
    value: 'cats'
  }]
}

Rehype

This plugin is compatible with rehype. Mark mdast nodes will become <mark>contents</mark>.

Installation

npm:

npm install remark-inserted

Usage

Dependencies:

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

const remarkInserted = require("remark-inserted");

Usage:

unified()
  .use(remarkParse)
  .use(remarkInserted)
  .use(remark2rehype)
  .use(stringify);

License

MIT © John McDowall