Add mdast to control markdown

.mdastignore

@@ -0,0 +1,2 @@
+bower_components
+components

.mdastrc

@@ -0,0 +1,11 @@
+{
+  "plugins": [
+    "comment-config",
+    "github",
+    "toc",
+    "usage"
+  ],
+  "settings": {
+    "bullet": "*"
+  }
+}

.npmignore

@@ -9,6 +9,7 @@ node_modules/
 test/
 benchmark.js
 build.js
+example.js
 bower.json
 component.json
 History.md

History.md

@@ -1,55 +1,59 @@
+<!-- mdast setext -->
 
 0.1.3 / 2015-01-12
 ==================
 
-  * Update CLI-usage in `Readme.md`
-  * Update CLI with pipe-in detection, other fixes
-  * Add test to CLI to fail without arguments or stdin
-  * Remove `exit 0` on success in `test/cli.sh`
-  * Move `test/index.sh` to `test/cli.sh`
-  * Update copyright notice in `LICENSE` to include 2015
-  * Add link to whole license in `Readme.md`
-  * Add Duo as an instalation method in `Readme.md`
-  * Add links to installation methods in `Readme.md`
-  * Refactor npm scripts for changes in npm
-  * Update jscs-jsdoc
-  * Update eslint
+*   Update CLI-usage in `Readme.md`
+*   Update CLI with pipe-in detection, other fixes
+*   Add test to CLI to fail without arguments or stdin
+*   Remove `exit 0` on success in `test/cli.sh`
+*   Move `test/index.sh` to `test/cli.sh`
+*   Update copyright notice in `LICENSE` to include 2015
+*   Add link to whole license in `Readme.md`
+*   Add Duo as an instalation method in `Readme.md`
+*   Add links to installation methods in `Readme.md`
+*   Refactor npm scripts for changes in npm
+*   Update jscs-jsdoc
+*   Update eslint
 
 0.1.2 / 2014-12-16
 ==================
 
- * Add CLI
- * Refactor to adhere to strict jsdoc style
- * Add jscs-jsdoc configuration to `.jscs.json`
- * Add jscs-jsdoc as a dev-dependency
- * Refactor npm script targets in `package.json`
- * Add link to personal website to copyright in `Readme.md`
- * Fix incorrect executive rights on `test/index.js`
- * Update eslint, matcha
+*   Add CLI
+*   Refactor to adhere to strict jsdoc style
+*   Add jscs-jsdoc configuration to `.jscs.json`
+*   Add jscs-jsdoc as a dev-dependency
+*   Refactor npm script targets in `package.json`
+*   Add link to personal website to copyright in `Readme.md`
+*   Fix incorrect executive rights on `test/index.js`
+*   Update eslint, matcha
 
 0.1.1 / 2014-11-03
 ==================
 
- * Refactor npm script target order in `package.json`
- * Update package description
- * Refactor module
- * Refactor test
- * Refactor benchmark
- * Move `benchmark/index.js` to `benchmark.js`
- * Refactor `data/problematic.json`
- * Add flat badges to `Readme.md`
- * Add `.eslintrc`
- * Refactor `.jscs.json`
- * Refactor to disallow space after object keys
- * Move `spec/` to `test/`, `test/syllable.spec.js` to `test/index.js`
- * Update `.gitignore`, `.npmignore`, bower ignore
- * Update eslint, mocha
+*   Refactor npm script target order in `package.json`
+*   Update package description
+*   Refactor module
+*   Refactor test
+*   Refactor benchmark
+*   Move `benchmark/index.js` to `benchmark.js`
+*   Refactor `data/problematic.json`
+*   Add flat badges to `Readme.md`
+*   Add `.eslintrc`
+*   Refactor `.jscs.json`
+*   Refactor to disallow space after object keys
+*   Move `spec/` to `test/`, `test/syllable.spec.js` to `test/index.js`
+*   Update `.gitignore`, `.npmignore`, bower ignore
+*   Update eslint, mocha
 
 0.1.0 / 2014-10-07
 ==================
 
- * Remove browser test
- * Remove testling
- * Refactor property order in package.json, component.json, bower.json
- * Update .gitignore, .npmignore, bower ignore
- * Add benchmark
+*   Remove browser test
+*   Remove testling
+*   Refactor property order in package.json, component.json, bower.json
+*   Update .gitignore, .npmignore, bower ignore
+*   Add benchmark
+
+0.0.1 / 2014-09-13
+==================

Readme.md

@@ -30,14 +30,22 @@ var syllable = require('wooorm/syllable');
 
 ## Usage
 
+Dependencies:
+
 ```javascript
+
 var syllable = require('syllable');
+```
+
+Results:
+
+```javascript
 
-syllable("syllable"); // 3
-syllable("unicorn"); // 3
-syllable("hi"); // 1
-syllable("hihi"); // 2
-syllable("mmmmmmmmmmmmmmmm"); // 1
+syllable('syllable'); // 3
+syllable('unicorn'); // 3
+syllable('hi'); // 1
+syllable('hihi'); // 2
+syllable('mmmmmmmmmmmmmmmm'); // 1
 ```
 
 ## CLI

bower.json

@@ -35,6 +35,7 @@
     "package.json",
     "benchmark.js",
     "build.js",
-    "cli.js"
+    "cli.js",
+    "example.js"
   ]
 }

example.js

@@ -0,0 +1,11 @@
+// Dependencies:
+
+var syllable = require('./index.js');
+
+// Results:
+
+syllable('syllable'); // 3
+syllable('unicorn'); // 3
+syllable('hi'); // 1
+syllable('hihi'); // 2
+syllable('mmmmmmmmmmmmmmmm'); // 1

package.json

@@ -28,6 +28,11 @@
     "jscs": "^1.0.0",
     "jscs-jsdoc": "^0.4.0",
     "matcha": "^0.6.0",
+    "mdast": "^0.19.0",
+    "mdast-comment-config": "^0.1.0",
+    "mdast-github": "^0.2.0",
+    "mdast-toc": "^0.3.0",
+    "mdast-usage": "^0.2.0",
     "mocha": "^2.0.0"
   },
   "scripts": {
@@ -40,7 +45,9 @@
     "lint-api": "eslint {index,cli,benchmark}.js test",
     "lint-style": "jscs --reporter inline {index,cli,benchmark}.js test",
     "lint": "npm run lint-api && npm run lint-style",
+    "build-md": "mdast . --output",
     "make": "npm run lint && npm run test-coverage",
+    "build": "npm run build-md",
     "install-benchmark": "npm install syllablistic text-statistics",
     "benchmark": "matcha benchmark.js"
   }