Update docs.

mkdoc · Mar 25, 2016 · a56dbab · a56dbab
1 parent aa7a6ce
commit a56dbab
Show file tree

Hide file tree

Showing 3 changed files with 44 additions and 183 deletions.
diff --git a/API.md b/API.md
diff --git a/README.md b/README.md
@@ -196,6 +196,49 @@ But be careful the tree can be very deep so it is not recommended you set
 
 * `indent` Number=0 number of spaces to indent the JSON.
 
+### Links
+
+```javascript
+new Links()
+```
+
+Manages a list of links and their destinations in a linked list.
+
+The `links` array is a list of nodes and `destinations` maps link
+destinations to their index in the array.
+
+### .add
+
+```javascript
+Links.prototype.add(node)
+```
+
+Add a link node to this collection of links.
+
+Returns a boolean indicating whether the link was added.
+
+* `node` Object the link node.
+
+### .list
+
+```javascript
+Links.prototype.list([newline])
+```
+
+Retrieves a list of link references.
+
+Returns list of link references.
+
+* `newline` String the newline character to use.
+
+### .reset
+
+```javascript
+Links.prototype.reset()
+```
+
+Resets this instance so it does not contain any links.
+
 ### ManRenderer
 
 ```javascript
@@ -337,7 +380,7 @@ MIT
 
 ---
 
-Created by [mkdoc](https://github.com/mkdoc/mkdoc) on March 25, 2016
+*Created by [mkdoc](https://github.com/mkdoc/mkdoc) on March 25, 2016*
 
 [mkdoc]: https://github.com/mkdoc/mkdoc
 [node]: http://nodejs.org

diff --git a/mkdoc.js b/mkdoc.js
@@ -1,22 +1,5 @@
 var mk = require('mktask');
 
-// @task api build the api docs.
-function api(cb) {
-  mk.api(
-    [
-      'index.js',
-      'lib/json.js',
-      'lib/man.js',
-      'lib/markdown.js',
-      'lib/text.js',
-      'lib/yaml.js'
-    ],
-    {
-      stream: mk.dest('API.md'),
-      heading: 'API'
-    }, cb);
-}
-
 // @task readme build the readme file.
 function readme(cb) {
   mk.doc('doc/readme.md')
@@ -29,5 +12,4 @@ function readme(cb) {
     .on('finish', cb);
 }
 
-mk.task(api);
 mk.task(readme);