Skip to content
plugin to configure remark with YAML frontmatter
JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.editorconfig Update code-style to use xo Aug 26, 2016
.gitignore
.npmrc
.prettierignore
.travis.yml
index.js Add origin to option setting failure Jun 16, 2019
license
package.json Update dev-dependencies Jul 22, 2019
readme.md
test.js

readme.md

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.

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) attack.

Related

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

You can’t perform that action at this time.