Awesome
remark-comment-config
remark plugin to configure it with comments.
Contents
- What is this?
- When should I use this?
- Install
- Use
- API
- 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.
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 16+), install with npm:
npm install remark-comment-config
In Deno with esm.sh
:
import remarkCommentConfig from 'https://esm.sh/remark-comment-config@8'
In browsers with esm.sh
:
<script type="module">
import remarkCommentConfig from 'https://esm.sh/remark-comment-config@8?bundle'
</script>
Use
Say we have the following file example.md
:
# Moons of Neptune
<!--remark bullet="+"-->
- Naiad
<!--remark bullet="-"-->
- Thalassa
<!--remark bullet="*"-->
- Despina
…and a module example.js
:
import {remark} from 'remark'
import remarkCommentConfig from 'remark-comment-config'
import {read} from 'to-vfile'
const file = await remark()
.use(remarkCommentConfig)
.process(await read('example.md'))
console.log(String(file))
…then running node example.js
yields:
# Moons of Neptune
<!--remark bullet="+"-->
+ Naiad
<!--remark bullet="-"-->
- Thalassa
<!--remark bullet="*"-->
* Despina
API
This package exports no identifiers.
The default export is remarkCommentConfig
.
unified().use(remarkCommentConfig)
Configure remark with comments.
Comments should start with remark
and contain “attributes” for settings.
For example, <!--remark foo="bar" baz-->
.
The settings are passed to remark-stringify
.
Parameters
There are no parameters.
Returns
Nothing (undefined
).
Types
This package is fully typed with TypeScript. It exports no additional types.
Compatibility
Projects maintained by the unified collective are compatible with maintained versions of Node.js.
When we cut a new major release, we drop support for unmaintained versions of
Node.
This means we try to keep the current release line, remark-comment-config@^8
,
compatible with Node.js 16.
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 YAMLremark-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.