remark-yaml-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 YAML frontmatter.

Contents

* What is this?
* When should I use this?
* Install
* Use
* API
* unified().use(remarkYamlConfig)
* 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 YAML frontmatter.

When should I use this?

This project is useful when you want to change how markdown is formatted 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-comment-config][remark-comment-config].
The difference is that that plugin uses comments, which can come anywhere in the
document, whereas this plugin uses YAML frontmatter, which comes at the start of
documents.

Install

This package is [ESM only][esm].
In Node.js (version 16+), install with [npm][]:

``sh
npm install remark-yaml-config
`

In Deno with [esm.sh][esmsh]:

`js
import remarkYamlConfig from 'https://esm.sh/remark-yaml-config@7'
`

In browsers with [esm.sh][esmsh]:

`html

`

Use

Say we have the following file example.md:

`markdown
---
remark:
bullet: "+"
---

- Triton
`

…and a module example.js:

`js
import {remark} from 'remark'
import remarkFrontmatter from 'remark-frontmatter'
import remarkYamlConfig from 'remark-yaml-config'
import {read} from 'to-vfile'

const file = await remark()
.use(remarkFrontmatter)
.use(remarkYamlConfig)
.process(await read('example.md'))

console.log(String(file))
`

> ⚠️ Important: [remark-frontmatter][remark-frontmatter] is needed to
> support YAML frontmatter in markdown.

…then running node example.js yields:

`markdown
---
remark:
bullet: "+"
---

+ Triton
`

API

This package exports no identifiers.
The default export is [remarkYamlConfig][api-remark-yaml-config].

$3

Configure remark with YAML frontmatter.

Parses YAML frontmatter and takes the value of the remark field as settings.
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-yaml-config@^7,
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-yaml-config can change how markdown is parsed or compiled.
If the markdown is user provided, this may open you up to a
[cross-site scripting (XSS)][wiki-xss] attack.

Related

* [remark-frontmatter][remark-frontmatter]
— support frontmatter (YAML, TOML, and more)
* [remark-comment-config][remark-comment-config]
— configure remark 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-yaml-config/workflows/main/badge.svg

[build]: https://github.com/remarkjs/remark-yaml-config/actions

[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-yaml-config.svg

[coverage]: https://codecov.io/github/remarkjs/remark-yaml-config

[downloads-badge]: https://img.shields.io/npm/dm/remark-yaml-config.svg

[downloads]: https://www.npmjs.com/package/remark-yaml-config

[size-badge]: https://img.shields.io/bundlejs/size/remark-yaml-config

[size]: https://bundlejs.com/?q=remark-yaml-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-frontmatter]: https://github.com/remarkjs/remark-frontmatter

[remark-comment-config]: https://github.com/remarkjs/remark-comment-config

[remark-stringify-options]: https://github.com/remarkjs/remark/blob/main/packages/remark-stringify/readme.md#options

[typescript]: https://www.typescriptlang.org

[unified]: https://github.com/unifiedjs/unified

[wiki-xss]: https://en.wikipedia.org/wiki/Cross-site_scripting

[api-remark-yaml-config]: #unifieduseremarkyamlconfig