remark-yaml-config
!Buildbuild-badgebuild
!Coveragecoverage-badgecoverage
!Downloadsdownloads-badgedownloads
!Sizesize-badgesize
!Sponsorssponsors-badgecollective
!Backersbackers-badgecollective
!Chatchat-badgechatremark plugin to configure it with YAML frontmatter.
Contents
* [`unified().use(remarkYamlConfig)`](#unifieduseremarkyamlconfig)
What is this?
This package is a unified (remark) plugin to configure remark (specifically, howremark-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 onlyesm. In Node.js (version 16+), install with npm:npm install remark-yaml-config
In Deno with
esm.sh
esmsh:import remarkYamlConfig from 'https://esm.sh/remark-yaml-config@7'
In browsers with
esm.sh
esmsh:<script type="module">
import remarkYamlConfig from 'https://esm.sh/remark-yaml-config@7?bundle'
</script>
Use
Say we have the following fileexample.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 isremarkYamlConfig
api-remark-yaml-config.unified().use(remarkYamlConfig)
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 ofremark-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
— support frontmatter (YAML, TOML, and more)
— configure remark with comments
Contribute
Seecontributing.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 conductcoc. By interacting with this repository, organization, or community you agree to abide by its terms.