Package Exports

remark-comment-config

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (remark-comment-config) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

remark-comment-config

Configure remark with comments.

Installation

npm:

npm install remark-comment-config

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

Usage

Dependencies:

var commentConfig = require('remark-comment-config');
var remark = require('remark');

Process:

var file = remark().use(commentConfig).process([
    '<!--remark commonmark bullet="*"-->',
    '',
    '1) Commonmark list (this is a parse setting)',
    '',
    '- List item (this is a stringification setting)',
    ''
].join('\n'));

Yields:

<!--remark commonmark bullet="*"-->

1.  Commonmark list (this is a parse setting)

*   List item (this is a stringification setting)

API

`remark.use(commentConfig)`

Parses comments, such as , and passes the “attributes” as parse and stringify.

Just like remark-yaml-config, but comments are invisible when rendering to HTML, such as on GitHub.