Socket
Socket
Sign inDemoInstall

remark-comment

Package Overview
Dependencies
4
Maintainers
1
Versions
1
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    remark-comment

Remark plugin to support comments


Version published
Maintainers
1
Install size
129 kB
Created

Readme

Source

remark-comment

Parse HTML style comments as a different node type so it can be ignored during serialization.

Install and usage

npm install remark-comment
import { unified } from 'unified'
import remarkParse from 'remark-parse'
import remarkComment from 'remark-comment'

unified().use(remarkParse).use(remarkComment)

For more help with unified, please see the docs for unified and remark.

This package also exports its micromark and [mdast-util] plugins:

import {
  comment,
  commentHtml,
  commentFromMarkdown,
  commentToMarkdown,
} from 'remark-comment'

Options:

The remarkComment and commentFromMarkdown functions take the options:

  • ast: If true, a { type: "comment" } node will be included in the resulting AST. This is useful if you want to do post-processing and stringify back to markdown. Default: false.

Example

# This file

<!-- contains a comment -->

And a paragraph

Renders to:

<h1>This file</h1>
<p>And a paragraph</p>

Motivation

This package was created after realizing that MDX lacked support for HTML style comments. When trying to migrate an existing collection of markdown files to MDX, hitting syntax errors for HTML comments was a non-starter. Rather than go modify all those files to use a (more awkward) JSX expression comment, I created this plugin to add back this support.

However, I found this useful when used outside of MDX. Common markdown interprets an HTML comment as an HTML block, and during serialization will pass it directly through to the final HTML document. I typically do not want my markdown comments appearing in my final HTML documents, and this plugin achieves this effect.

Caveats

This plugin must be added after MDX, otherwise you will see this error:

Unexpected character `!` (U+0021) before name, expected a character that can start a name, such as a letter, `$`, or `_` (note: to create a comment in MDX, use `{/* text */}`)

In a unified pipeline:

unified().use(remarkMDX).use(remarkComment)

Comments cannot be used within a JSX body. JSX is still JSX. Comments must appear outside of JSX.

Similarly, when used with common markdown, a comment cannot be used within an HTML body. If it does it will be parsed as an HTML comment as part of the HTML body and emitted to the final document.

Keywords

FAQs

Last updated on 10 Jan 2022

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc