remark-comment-config - npm Package Compare versions

Comparing version 4.0.0-alpha.1 to 4.0.0

history.md

@@ -5,2 +5,7 @@ <!--remark setext-->
 
+4.0.0 / 2016-06-13
+==================
+
+*   Update for remark@5.0.0 ([`a3d015b`](https://github.com/wooorm/remark-comment-config/commit/a3d015b))
+
 3.0.0 / 2016-02-14
@@ -7,0 +12,0 @@ ==================

index.js

@@ -6,3 +6,3 @@ /**
  * @module remark:comment-config
- * @fileoverview Configure remark with comments at runtime.
+ * @fileoverview Configure remark with comments.
  */
@@ -9,0 +9,0 @@

package.json

 {
   "name": "remark-comment-config",
-  "version": "4.0.0-alpha.1",
-  "description": "Configure remark with comments at runtime",
+  "version": "4.0.0",
+  "description": "Configure remark with comments",
   "license": "MIT",
@@ -37,5 +37,5 @@ "keywords": [
     "remark-cli": "^1.0.0",
-    "remark-github": "^4.0.1",
+    "remark-github": "^5.0.0-alpga.1",
     "remark-lint": "^4.0.0",
-    "remark-usage": "^3.0.0",
+    "remark-usage": "^4.0.0-alpha.1",
     "tape": "^4.0.0"
@@ -42,0 +42,0 @@ },

readme.md

@@ -1,11 +0,11 @@
-# remark-comment-config [![Build Status][travis-badge]][travis] [![Coverage Status][codecov-badge]][codecov]
+# remark-comment-config [![Build Status][build-badge]][build-status] [![Coverage Status][coverage-badge]][coverage-status] [![Chat][chat-badge]][chat]
 
-Set [**remark**][remark] options with comments during runtime.
+Configure [**remark**][remark] with comments.
 
 ## Installation
 
-[npm][npm-install]:
+[npm][]:
 
 ```bash
-npm install remark-comment-config
+npm install remark-parse
 ```
@@ -28,3 +28,3 @@
 ```javascript
-var doc = remark().use(commentConfig).process([
+var file = remark().use(commentConfig).process([
     '<!--remark commonmark bullet="*"-->',
@@ -41,4 +41,8 @@ '',
 
-```javascript
-console.log('markdown', doc);
+```markdown
+<!--remark commonmark bullet="*"-->
+
+1.  Commonmark list (this is a parse setting)
+
+*   List item (this is a stringification setting)
 ```
@@ -51,7 +55,6 @@
 Parses comments, such as `<!--remark foo="bar" baz-->`, and passes the
-“attributes” as [settings](https://github.com/wooorm/remark#remarkprocessvalue-options-done)
-to **remark**.
+“attributes” as [parse][parse-settings] and [stringify][stringify-settings].
 
-Just like [**remark-yaml-config**](https://github.com/wooorm/remark-yaml-config),
-but comments are invisible when rendering to HTML, such as on GitHub.
+Just like [**remark-yaml-config**][remark-yaml-config], but comments are
+invisible when rendering to HTML, such as on GitHub.
 
@@ -64,12 +67,14 @@ ## License
 
-[travis-badge]: https://img.shields.io/travis/wooorm/remark-comment-config/master.svg
+[build-badge]: https://img.shields.io/travis/wooorm/remark-comment-config.svg
 
-[travis]: https://travis-ci.org/wooorm/remark-comment-config
+[build-status]: https://travis-ci.org/wooorm/remark-comment-config
 
-[codecov-badge]: https://img.shields.io/codecov/c/github/wooorm/remark-comment-config.svg
+[coverage-badge]: https://img.shields.io/codecov/c/github/wooorm/remark-comment-config.svg
 
-[codecov]: https://codecov.io/github/wooorm/remark-comment-config
+[coverage-status]: https://codecov.io/github/wooorm/remark-comment-config
 
-[npm-install]: https://docs.npmjs.com/cli/install
+[chat-badge]: https://img.shields.io/gitter/room/wooorm/remark.svg
 
+[chat]: https://gitter.im/wooorm/remark
+
 [releases]: https://github.com/wooorm/remark-comment-config/releases
@@ -81,2 +86,10 @@
 
+[npm]: https://docs.npmjs.com/cli/install
+
 [remark]: https://github.com/wooorm/remark
+
+[parse-settings]: https://github.com/wooorm/remark/blob/master/packages/remark-parse/readme.md#options
+
+[stringify-settings]: https://github.com/wooorm/remark/blob/master/packages/remark-stringify/readme.md#options
+
+[remark-yaml-config]: https://github.com/wooorm/remark-yaml-config

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

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

8389

increased by7.36%

Number of low quality alerts

1

decreased by-50%

Number of lines in readme file

91

increased by16.67%

No dependency changes