unified

Project:remarkjs/remark-yaml-config

Package:remark-yaml-config@4.1.0

  1. Dependencies:1·Dependents:15
  2. remark plugin to configure it with YAML frontmatter
  1. remark 170
  2. unified 132
  3. plugin 88
  4. markdown 80
  5. mdast 68
  6. yaml 3
  7. frontmatter 3
  8. options 2
  9. config 2
  10. settings 2

remark-yaml-config

Build Coverage Downloads Size Sponsors Backers Chat

remark plugin to configure it with YAML frontmatter. This requires remark-frontmatter as well.

Install

npm:

npm install remark-yaml-config

Use

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)

Plugin to configure it with YAML frontmatter. Takes the 'remark' field in the frontmatter and passes it as configuration to parse and stringify.

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

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, organisation, or community you agree to abide by its terms.

License

MIT © Titus Wormer