https://github.com/remarkjs/remark-comment-config
plugin to configure remark with comments
https://github.com/remarkjs/remark-comment-config
comment markdown remark remark-plugin
Last synced: 5 months ago
JSON representation
plugin to configure remark with comments
- Host: GitHub
- URL: https://github.com/remarkjs/remark-comment-config
- Owner: remarkjs
- License: mit
- Created: 2015-04-15T11:41:55.000Z (about 11 years ago)
- Default Branch: main
- Last Pushed: 2023-09-22T12:09:16.000Z (over 2 years ago)
- Last Synced: 2025-12-05T13:58:22.697Z (5 months ago)
- Topics: comment, markdown, remark, remark-plugin
- Language: JavaScript
- Homepage: https://remark.js.org
- Size: 135 KB
- Stars: 15
- Watchers: 7
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
README
# remark-comment-config
[![Build][build-badge]][build]
[![Coverage][coverage-badge]][coverage]
[![Downloads][downloads-badge]][downloads]
[![Size][size-badge]][size]
[![Sponsors][sponsors-badge]][collective]
[![Backers][backers-badge]][collective]
[![Chat][chat-badge]][chat]
**[remark][]** plugin to configure it with comments.
## Contents
* [What is this?](#what-is-this)
* [When should I use this?](#when-should-i-use-this)
* [Install](#install)
* [Use](#use)
* [API](#api)
* [`unified().use(remarkCommentConfig)`](#unifieduseremarkcommentconfig)
* [Types](#types)
* [Compatibility](#compatibility)
* [Security](#security)
* [Related](#related)
* [Contribute](#contribute)
* [License](#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`][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][esm].
In Node.js (version 16+), install with [npm][]:
```sh
npm install remark-comment-config
```
In Deno with [`esm.sh`][esmsh]:
```js
import remarkCommentConfig from 'https://esm.sh/remark-comment-config@8'
```
In browsers with [`esm.sh`][esmsh]:
```html
import remarkCommentConfig from 'https://esm.sh/remark-comment-config@8?bundle'
```
## Use
Say we have the following file `example.md`:
```markdown
# Moons of Neptune
- Naiad
- Thalassa
- Despina
```
…and a module `example.js`:
```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:
```markdown
# Moons of Neptune
+ Naiad
- Thalassa
* Despina
```
## API
This package exports no identifiers.
The default export is [`remarkCommentConfig`][api-remark-comment-config].
### `unified().use(remarkCommentConfig)`
Configure remark with comments.
Comments should start with `remark` and contain “attributes” for settings.
For example, ``.
The settings are passed to [`remark-stringify`][remark-stringify-options].
###### 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)][wiki-xss] attack.
## Related
* [`remark-yaml-config`][remark-yaml-config]
— configure remark with YAML
* [`remark-message-control`][remark-message-control]
— configure messages with comments
## Contribute
See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways
to get started.
See [`support.md`][support] for ways to get help.
This project has a [code of conduct][coc].
By interacting with this repository, organization, or community you agree to
abide by its terms.
## License
[MIT][license] © [Titus Wormer][author]
[build-badge]: https://github.com/remarkjs/remark-comment-config/workflows/main/badge.svg
[build]: https://github.com/remarkjs/remark-comment-config/actions
[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-comment-config.svg
[coverage]: https://codecov.io/github/remarkjs/remark-comment-config
[downloads-badge]: https://img.shields.io/npm/dm/remark-comment-config.svg
[downloads]: https://www.npmjs.com/package/remark-comment-config
[size-badge]: https://img.shields.io/bundlejs/size/remark-comment-config
[size]: https://bundlejs.com/?q=remark-comment-config
[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg
[backers-badge]: https://opencollective.com/unified/backers/badge.svg
[collective]: https://opencollective.com/unified
[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg
[chat]: https://github.com/remarkjs/remark/discussions
[npm]: https://docs.npmjs.com/cli/install
[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
[esmsh]: https://esm.sh
[health]: https://github.com/remarkjs/.github
[contributing]: https://github.com/remarkjs/.github/blob/main/contributing.md
[support]: https://github.com/remarkjs/.github/blob/main/support.md
[coc]: https://github.com/remarkjs/.github/blob/main/code-of-conduct.md
[license]: license
[author]: https://wooorm.com
[remark]: https://github.com/remarkjs/remark
[remark-message-control]: https://github.com/remarkjs/remark-message-control
[remark-stringify-options]: https://github.com/remarkjs/remark/blob/main/packages/remark-stringify/readme.md#options
[remark-yaml-config]: https://github.com/remarkjs/remark-yaml-config
[typescript]: https://www.typescriptlang.org
[unified]: https://github.com/unifiedjs/unified
[wiki-xss]: https://en.wikipedia.org/wiki/Cross-site_scripting
[api-remark-comment-config]: #unifieduseremarkcommentconfig