remark-shortcodes - npm Package Compare versions

Comparing version 0.1.1 to 0.1.2

index.js

@@ -16,14 +16,10 @@ "use strict";
 
-
    e.g
-        // No arguments
+        // with no attributes
         [[ ShortcodeNameA ]]
 
-        // One argument
-        [[ ShortcodeNameB exampleAttribute="a" ]]
-
-        // Multiple argument
+        // with multiple attributes
         [[ ShortcodeNameC a="b" c="d" ]]
 
-        // Custom Start/End Blocks
+        // with custom start/end Blocks
         {{% ShortcodeNameD a="1" c="2" %}}
@@ -34,21 +30,6 @@
           type: 'shortcode',
-          data: {
-              name: 'ShortcodeNameC',
-              attributes: {
-                  a: '1',
-                  c: '2'
-              }
-          },
-          position: {
-              start: {
-                  line: 3,
-                  column: 1,
-                  offset: 15
-              },
-              end: {
-                  line: 3,
-                  column: 19,
-                  offset: 33
-              },
-              indent: []
+          identifier: 'ShortcodeNameC',
+          attributes: {
+              a: '1',
+              c: '2'
           }
@@ -55,0 +36,0 @@ }

package.json

 {
   "name": "remark-shortcodes",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "Shortcode parser plugin for Remark",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -1,2 +0,2 @@
-# remark-shortcodes [![Build Status][travis-badge]][travis] [![Coverage Status][codecov-badge]][codecov]
+# remark-shortcodes [![NPM Package][npm-package-badge]][npm-package] [![Build Status][travis-badge]][travis] [![Coverage Status][codecov-badge]][codecov]
 
@@ -39,11 +39,10 @@ A custom Markdown syntax parser for [**remark**][remark] that adds support for shortcodes.
 the shortcodes at the block level and convert them to a representation
-in its Markdown AST (MDAST). The representation is as follows:
+in its Markdown AST (MDAST). Given either example above, the representation would
+end up as follows:
 
 ```js
 {
-	type: "shortcode",
-	data: {
-		name: "MailchimpForm",
-		attributes: { id: "chfk2" }
-	}
+  type: "shortcode",
+  identifier: "MailchimpForm",
+  attributes: { id: "chfk2" }
 }
@@ -132,5 +131,5 @@ ```
 
-* Bump version in package.json
-* Commit and tag with version number (`git tag -a v0.1.x -m v0.1.x`)
-* Push
+- Bump version in package.json
+- Commit and tag with version number (`git tag -a v0.1.x -m v0.1.x`)
+- Push
 
@@ -145,2 +144,6 @@ ## License
 
+[npm-package-badge]: https://img.shields.io/npm/v/remark-shortcodes.svg
+
+[npm-package]: https://www.npmjs.org/package/remark-shortcodes
+
 [travis-badge]: https://img.shields.io/travis/djm/remark-shortcodes/master.svg
@@ -147,0 +150,0 @@

No alert changes

Improved metrics

Number of lines in readme file

165

increased by1.85%

Worsened metrics

Total package byte prevSize

11751

decreased by-1.61%

Lines of code

132

decreased by-11.41%

No dependency changes