remark-yaml-config

remark-yaml-config

Configure remark with YAML front-matter. This requires remark-frontmatter as well.

Installation

npm:

npm install remark-yaml-config

Usage

Say we have the following file, example.md:

---
remark:
  commonmark: true
  bullet: "*"
---

1)  Commonmark list (this is a parse setting)

*   Hello (this is a stringify setting)

And our script, example.js, looks as follows:

var vfile = require('to-vfile')
var remark = require('remark')
var frontmatter = require('remark-frontmatter')
var yamlConfig = require('remark-yaml-config')

remark()
  .use(frontmatter)
  .use(yamlConfig)
  .process(vfile.readSync('example.md'), function(err, file) {
    if (err) throw err
    console.log(String(file))
  })

Now, running node example yields:

---
remark:
  commonmark: true
  bullet: "*"
---

1.  Commonmark list (this is a parse setting)

*   Hello (this is a stringify setting)

API

remark.use(yamlConfig)

Passes the configuration at the remark field as parse and stringify settings to remark.

Just like remark-comment-config, but YAML is more visible.

Related

• remark-comment-config — Configure with comments
• remark-frontmatter — Frontmatter support, including yaml, toml, and more

Contribute

See contributing.md in remarkjs/remark for ways to get started.

This organisation has a Code of Conduct. By interacting with this repository, organisation, or community you agree to abide by its terms.

License

MIT © Titus Wormer