remark-ins

This package is a unified (remark) plugin to add <ins> element in markdown.

unified is a project that transforms content with abstract syntax trees (ASTs) using the new parser micromark. remark adds support for markdown to unified. mdast is the Markdown Abstract Syntax Tree (AST) which is a specification for representing markdown in a syntax tree.

This plugin is a remark plugin that transforms the mdast.

When should I use this?

This plugin is useful if you want to add a <ins> element in markdown, which represents a range of text that has been added to a document.

You can easily create <ins> element with the remark-ins.

Installation

This package is suitable for ESM only. In Node.js (version 16+), install with npm:

npm install remark-ins

or

yarn add remark-ins

Usage

use ++ around the content

Say we have the following file, example.md, which consists some flexible markers.

++inserted text++

And our module, example.js, looks as follows:

import { read } from "to-vfile";
import remark from "remark";
import gfm from "remark-gfm";
import remarkRehype from "remark-rehype";
import rehypeStringify from "rehype-stringify";
import remarkIns from "remark-ins";

main();

async function main() {
  const file = await remark()
    .use(gfm)
    .use(remarkIns)
    .use(remarkRehype)
    .use(rehypeStringify)
    .process(await read("example.md"));

  console.log(String(file));
}

Now, running node example.js yields:\

<p><ins class="remark-ins">inserted text</ins></p>

Without remark-ins, you’d get:

<p>++inserted text++</p>

[!CAUTION] The double plus signs must be adjacent to the content.
The content must be wrapped with double plus signs, not singular at any side.\

Here are some bad usage, and will not work.

++text with bad wrapped+

+text with bad wrapped++

++ text with unwanted space++

++text with unwanted space ++

It is more flexible and powerful

As of version ^1.1.0, the remark-ins can handle also the syntax containing other markdown phrases like strong, emphasis, link etc. For example:

++**inserted bold content**++

++_inserted italic content_++

++[inserted link](https://google.com)++

<p>
  <ins class="remark-ins">
    <strong>inserted bold content</strong>
  </ins>
</p>
<p>
  <ins class="remark-ins">
    <em>inserted italic content</em>
  </ins>
</p>
<p>
  <ins class="remark-ins">
    <a href="https://google.com">inserted link</a>
  </ins>
</p>

Options

There is no option for the remark-ins.

Example:

~~deleted content~~ and ++inserted content++

**++inserted bold content++** and ++**inserted bold content**++

### Heading with ++inserted content++

is going to produce as default:

<p>
  <del>deleted content</del>
   and 
  <ins class="remark-ins">inserted content</ins>
</p>
<p>
  <strong><ins class="remark-ins">inserted bold content</ins></strong>
   and 
  <ins class="remark-ins"><strong>inserted bold content</strong></ins>
</p>
<h3>Heading with <ins class="remark-ins">inserted content</ins></h3>

You can use the ins syntax in the tables, headings, lists, blockquotes etc. For detailed examples, you can have a look at the test files in the github repo.

Syntax tree

This plugin only modifies the mdast (markdown abstract syntax tree) as explained.

Types

This package is fully typed with TypeScript.

Compatibility

This plugin works with unified version 6+ and remark version 7+. It is compatible with mdx version 2+.

Security

Use of remark-ins does not involve rehype (hast) or user content so there are no openings for cross-site scripting (XSS) attacks.

My Plugins

I like to contribute the Unified / Remark / MDX ecosystem, so I recommend you to have a look my plugins.

My Remark Plugins

• remark-flexible-code-titles – Remark plugin to add titles or/and containers for the code blocks with customizable properties
• remark-flexible-containers – Remark plugin to add custom containers with customizable properties in markdown
• remark-ins – Remark plugin to add ins element in markdown
• remark-flexible-paragraphs – Remark plugin to add custom paragraphs with customizable properties in markdown
• remark-flexible-markers – Remark plugin to add custom mark element with customizable properties in markdown
• remark-flexible-toc – Remark plugin to expose the table of contents via Vfile.data or via an option reference
• remark-mdx-remove-esm – Remark plugin to remove import and/or export statements (mdxjsEsm)

My Rehype Plugins

• rehype-pre-language – Rehype plugin to add language information as a property to pre element

My Recma Plugins

• recma-mdx-escape-missing-components – Recma plugin to set the default value () => null for the Components in MDX in case of missing or not provided so as not to throw an error
• recma-mdx-change-props – Recma plugin to change the props parameter into the _props in the function _createMdxContent(props) {/* */} in the compiled source in order to be able to use {props.foo} like expressions. It is useful for the next-mdx-remote or next-mdx-remote-client users in nextjs applications.

License

MIT License © ipikuka

Keywords

🟩 unified 🟩 remark 🟩 remark plugin 🟩 mdast markdown 🟩 remark ins 🟩 remark inserted text