[
[
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.
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.
This package is suitable for ESM only. In Node.js (version 16+), install with npm:
npm install remark-insor
yarn add remark-insSay 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 ++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>There is no option for the remark-ins.
~~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.
This plugin only modifies the mdast (markdown abstract syntax tree) as explained.
This package is fully typed with TypeScript.
This plugin works with unified version 6+ and remark version 7+. It is compatible with mdx version 2+.
Use of remark-ins does not involve rehype (hast) or user content so there are no openings for cross-site scripting (XSS) attacks.
I like to contribute the Unified / Remark / MDX ecosystem, so I recommend you to have a look my plugins.
remark-flexible-code-titles– Remark plugin to add titles or/and containers for the code blocks with customizable propertiesremark-flexible-containers– Remark plugin to add custom containers with customizable properties in markdownremark-ins– Remark plugin to addinselement in markdownremark-flexible-paragraphs– Remark plugin to add custom paragraphs with customizable properties in markdownremark-flexible-markers– Remark plugin to add custommarkelement with customizable properties in markdownremark-flexible-toc– Remark plugin to expose the table of contents viavfile.dataor via an option referenceremark-mdx-remove-esm– Remark plugin to remove import and/or export statements (mdxjsEsm)
rehype-pre-language– Rehype plugin to add language information as a property topreelementrehype-highlight-code-lines– Rehype plugin to add line numbers to code blocks and allow highlighting of desired code linesrehype-code-meta– Rehype plugin to copycode.data.metatocode.properties.metastringrehype-image-toolkit– Rehype plugin to enhance Markdown image syntax![]()and Markdown/MDX media elements (<img>,<audio>,<video>) by auto-linking bracketed or parenthesized image URLs, wrapping them in<figure>with optional captions, unwrapping images/videos/audio from paragraph, parsing directives in title for styling and adding attributes, and dynamically converting images into<video>or<audio>elements based on file extension.
recma-mdx-escape-missing-components– Recma plugin to set the default value() => nullfor the Components in MDX in case of missing or not provided so as not to throw an errorrecma-mdx-change-props– Recma plugin to change thepropsparameter into the_propsin thefunction _createMdxContent(props) {/* */}in the compiled source in order to be able to use{props.foo}like expressions. It is useful for thenext-mdx-remoteornext-mdx-remote-clientusers innextjsapplications.recma-mdx-change-imports– Recma plugin to convert import declarations for assets and media with relative links into variable declarations with string URLs, enabling direct asset URL resolution in compiled MDX.recma-mdx-import-media– Recma plugin to turn media relative paths into import declarations for both markdown and html syntax in MDX.recma-mdx-import-react– Recma plugin to ensure gettingReactinstance from the arguments and to make the runtime props{React, jsx, jsxs, jsxDev, Fragment}is available in the dynamically imported components in the compiled source of MDX.recma-mdx-html-override– Recma plugin to allow selected raw HTML elements to be overridden via MDX components.recma-mdx-interpolate– Recma plugin to enable interpolation of identifiers wrapped in curly braces within thealt,src,href, andtitleattributes of markdown link and image syntax in MDX.
MIT License © ipikuka