gitbook-plugin-blackbeard - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

package.json

@@ -19,3 +19,3 @@ {
   "scripts": {},
-  "version": "1.0.0",
+  "version": "1.0.1",
   "repository": {
@@ -22,0 +22,0 @@ "type": "git",

README.md

@@ -1,25 +0,26 @@
-## plugin-github
+## Blackbeard.js GitBook plugin
 
-Display a link to your GitHub repo in your gitbook.
+This is a plugin used to write the Blackbeard.js documentation. It adds a few things to the original markdown syntax:
 
-### Usage
 
-Put this in your book.json:
+... a table of contents, automatically generated from the headlines in the document:
+```
+<!--- toc --->
+```
 
-```js
-{
-    "plugins": [ "github" ],
-    "pluginsConfig": {
-        "github": {
-            "url": "https://github.com/your/repo"
-        }
-    }
-}
+... support badges:
 ```
+<!-- support:<ios (0-4)>:<android (0-4)>:<windows (0-4)> -->
+```
 
-And you're done!
+... stability level blocks:
+```
+<!-- stability:<0-4> -->
+```
 
-### Credits
+... stability level boxes:
+```
+<!-- stability-level:<0-4> -->
+```
 
-Original work by [@mjackson](https://github.com/mjackson).
-
+It also allows for easy referencing to headlines in the document (or standard JavaScript objects), without having to maintain a reference list at the bottom.

No alert changes

Improved metrics

Total package byte prevSize

25929

increased by1.11%

Number of lines in readme file

27

increased by3.85%

No dependency changes