Product
Introducing License Enforcement in Socket
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
remark-comment
Advanced tools
Parse HTML style comments as a different node type so it can be ignored during serialization.
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
.# This file
<!-- contains a comment -->
And a paragraph
Renders to:
<h1>This file</h1>
<p>And a paragraph</p>
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.
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.
FAQs
Remark plugin to support comments
The npm package remark-comment receives a total of 724 weekly downloads. As such, remark-comment popularity was classified as not popular.
We found that remark-comment demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
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.
Product
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Product
We're launching a new set of license analysis and compliance features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.
Product
We're excited to introduce Socket Optimize, a powerful CLI command to secure open source dependencies with tested, optimized package overrides.