remark-yaml-config

remark-yaml-config

Configure remark with YAML front-matter.

Installation

npm:

npm install remark-yaml-config

remark-yaml-config is also available as an AMD, CommonJS, and globals module, uncompressed and compressed.

Usage

Dependencies:

var remark = require('remark');
var config = require('remark-yaml-config');

Process:

var file = remark().use(config).process([
    '---',
    'remark:',
    '  commonmark: true',
    '  bullet: "*"',
    '---',
    '',
    '1) Commonmark list (this is a parse setting)',
    '',
    '- Hello (this is a stringification setting)',
    ''
].join('\n'));

Yields:

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

1.  Commonmark list (this is a parse setting)

*   Hello (this is a stringification setting)

API

remark.use(yamlConfig)

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

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

License

MIT © Titus Wormer