remark-comment-config

remark-comment-config

remark plugin to configure it with comments.

Contents

• What is this?
• When should I use this?
• Install
• Use
• API
  • unified().use(remarkCommentConfig)
• Types
• Compatibility
• Security
• Related
• Contribute
• License

What is this?

This package is a unified (remark) plugin to configure remark (specifically, how remark-stringify formats markdown) from comments.

unified is a project that transforms content with abstract syntax trees (ASTs). remark adds support for markdown to unified. mdast is the markdown AST that remark uses. This is a remark plugin that configures how remark-stringify serializes mdast.

When should I use this?

This project is useful when you want to change how markdown is formatted, repeatedly, from within a file. You can use this when you trust authors and want to give them control.

This plugin is very similar to the alternative remark-yaml-config. The difference is that that plugin uses YAML frontmatter, which comes at the start of documents, whereas this plugin uses comments, which can come anywhere in the document.

Install

This package is ESM only. In Node.js (version 12.20+, 14.14+, or 16.0+), install with npm:

npm install remark-comment-config

In Deno with Skypack:

import remarkCommentConfig from 'https://cdn.skypack.dev/remark-comment-config@7?dts'

In browsers with Skypack:

<script type="module">
  import remarkCommentConfig from 'https://cdn.skypack.dev/remark-comment-config@7?min'
</script>

Use

Say we have the following file example.md:

<!--remark bullet="+"-->

- a

<!--remark bullet="-"-->

- b

<!--remark bullet="*"-->

- c

And our module example.js looks as follows:

import {read} from 'to-vfile'
import {remark} from 'remark'
import remarkCommentConfig from 'remark-comment-config'

main()

async function main() {
  const file = await remark()
    .use(remarkCommentConfig)
    .process(await read('example.md'))

  console.log(String(file))
}

Now running node example.js yields:

<!--remark bullet="+"-->

+   a

<!--remark bullet="-"-->

-   b

<!--remark bullet="*"-->

*   c

API

This package exports no identifiers. The default export is remarkCommentConfig.

unified().use(remarkCommentConfig)

Configure remark with comments. There are no options.

Comments should start with remark and contain “attributes” for settings. For example, <!--remark foo="bar" baz-->. The settings are passed to remark-stringify.

Types

This package is fully typed with TypeScript. There are no extra exported types.

Compatibility

Projects maintained by the unified collective are compatible with all maintained versions of Node.js. As of now, that is Node.js 12.20+, 14.14+, and 16.0+. Our projects sometimes work with older versions, but this is not guaranteed.

This plugin works with remark version 13+. Version 5 (and lower) worked with older versions of remark.

Security

Use of remark-comment-config can change how markdown is compiled. If the markdown is user provided, this may open you up to a cross-site scripting (XSS) attack.

Related

• remark-yaml-config — configure remark with YAML
• remark-message-control — configure messages with comments

Contribute

See contributing.md in remarkjs/.github for ways to get started. See support.md for ways to get help.

This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.

License

MIT © Titus Wormer