remark-comments - npm Package Compare versions

Comparing version 0.0.6 to 0.0.7

dist/index.js

@@ -11,3 +11,3 @@ 'use strict';
 
-function inlinePlugin() {
+function plugin() {
   var opts = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
@@ -38,2 +38,2 @@
 
-module.exports = inlinePlugin;
+module.exports = plugin;

package.json

 {
   "name": "remark-comments",
-  "version": "0.0.6",
+  "version": "0.0.7",
   "repository": {
@@ -5,0 +5,0 @@ "url": "https://github.com/zestedesavoir/zmarkdown/tree/master/packages/remark-comments",

README.md

@@ -1,1 +0,70 @@
-This plugin makes remark ignore comments from Markdown input (`<--COMMENTS xxx COMMENTS-->`)
+# remark-comments [![Build Status][build-badge]][build-status] [![Coverage Status][coverage-badge]][coverage-status]
+
+This plugin parses custom Markdown syntax for Markdown source comments.
+
+## Syntax
+
+You can write comments in the Markdown source this way:
+
+```markdown
+Foo<--COMMENTS I am a comment COMMENTS-->bar
+```
+
+Everything between `<--COMMENTS` and `COMMENTS-->` will be absent from the output.
+
+## Installation
+
+[npm][npm]:
+
+```bash
+npm install remark-comments
+```
+
+## Usage
+
+Dependencies:
+
+```javascript
+const unified = require('unified')
+const remarkParse = require('remark-parse')
+const stringify = require('rehype-stringify')
+const remark2rehype = require('remark-rehype')
+
+const remarkComments = require('remark-comments')
+```
+
+Usage:
+
+```javascript
+unified()
+  .use(remarkParse)
+  .use(remarkComments)
+  .use(remark2rehype)
+  .use(stringify)
+```
+
+## License
+
+[MIT][license] © [Zeste de Savoir][zds]
+
+<!-- Definitions -->
+
+[build-badge]: https://img.shields.io/travis/zestedesavoir/zmarkdown.svg
+
+[build-status]: https://travis-ci.org/zestedesavoir/zmarkdown
+
+[coverage-badge]: https://img.shields.io/coveralls/zestedesavoir/zmarkdown.svg
+
+[coverage-status]: https://coveralls.io/github/zestedesavoir/zmarkdown
+
+[license]: https://github.com/zestedesavoir/zmarkdown/blob/master/packages/remark-comments/LICENSE-MIT
+
+[zds]: https://zestedesavoir.com
+
+[npm]: https://www.npmjs.com/package/remark-comments
+
+[mdast]: https://github.com/syntax-tree/mdast/blob/master/readme.md
+
+[remark]: https://github.com/wooorm/remark
+
+[rehype]: https://github.com/wooorm/rehype

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

4614

increased by46.8%

Number of lines in readme file

71

increased by3450%

No dependency changes