remark-comment-config
Advanced tools
Comparing version 5.0.0 to 5.0.1
{ | ||
"name": "remark-comment-config", | ||
"version": "5.0.0", | ||
"version": "5.0.1", | ||
"description": "Configure remark with comments", | ||
@@ -19,5 +19,2 @@ "license": "MIT", | ||
], | ||
"engines": { | ||
"node": ">=0.11.0" | ||
}, | ||
"dependencies": { | ||
@@ -32,13 +29,13 @@ "mdast-comment-marker": "^1.0.1" | ||
"esmangle": "^1.0.0", | ||
"nyc": "^10.0.0", | ||
"nyc": "^11.0.0", | ||
"remark": "^7.0.0", | ||
"remark-cli": "^2.0.0", | ||
"remark-cli": "^3.0.0", | ||
"remark-html": "^6.0.0", | ||
"remark-preset-wooorm": "^1.0.0", | ||
"remark-preset-wooorm": "^3.0.0", | ||
"tape": "^4.4.0", | ||
"unified": "^6.0.0", | ||
"xo": "^0.17.0" | ||
"xo": "^0.18.0" | ||
}, | ||
"scripts": { | ||
"build-md": "remark . --quiet --frail", | ||
"build-md": "remark . -qfo", | ||
"build-bundle": "browserify index.js -s remarkCommentConfig > remark-comment-config.js", | ||
@@ -60,2 +57,3 @@ "build-mangle": "esmangle remark-comment-config.js > remark-comment-config.min.js", | ||
"space": true, | ||
"esnext": false, | ||
"ignores": [ | ||
@@ -66,5 +64,6 @@ "remark-comment-config.js" | ||
"remarkConfig": { | ||
"output": true, | ||
"presets": "wooorm" | ||
"plugins": [ | ||
"preset-wooorm" | ||
] | ||
} | ||
} |
@@ -15,19 +15,28 @@ # remark-comment-config [![Build Status][build-badge]][build-status] [![Coverage Status][coverage-badge]][coverage-status] [![Chat][chat-badge]][chat] | ||
Say we have the following file, `example.md`: | ||
```markdown | ||
<!--remark commonmark bullet="*"--> | ||
1) Commonmark list (this is a parse setting) | ||
- List item (this is a stringification setting) | ||
``` | ||
And our script, `example.js`, looks as follows: | ||
```javascript | ||
var vfile = require('to-vfile'); | ||
var remark = require('remark'); | ||
var commentConfig = require('remark-comment-config'); | ||
var remark = require('remark'); | ||
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')); | ||
console.log(String(file)); | ||
remark() | ||
.use(commentConfig) | ||
.process(vfile.readSync('example.md'), function (err, file) { | ||
if (err) throw err; | ||
console.log(String(file)); | ||
}); | ||
``` | ||
Yields: | ||
Now, running `node example` yields: | ||
@@ -34,0 +43,0 @@ ```markdown |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
6240
91