Auto generate api.md using mocha

README.md

@@ -64,14 +64,18 @@ ipfs daemon
 
 ## API
 
-### Level 1 Commands
-Level 1 commands are simple commands
+You can find more detailed documentation with examples at [API.md](/API.md).
+
+
+
+
+-----------------------------------------------------------------------------
+
+### Previous API Docs
 
 #### add
 
-Add a file (where file is any data) to ipfs returning the hash and name. The
-name value will only be set if you are actually sending a file. A single or
-array of files can be used.
+Add a file (where file is any data) to ipfs returning the hash and name. The name value will only be set if you are actually sending a file. A single or array of files can be used.
 
 **Usage**
 ```javascript
@@ -84,8 +88,7 @@ ipfs.add(files, function(err, res) {
     })
 })
 ```
-`files` can be a mixed array of filenames or buffers of data. A single value is
-also acceptable.
+`files` can be a mixed array of filenames or buffers of data. A single value is also acceptable.
 
 Example
 ```js
@@ -185,9 +188,6 @@ curl "http://localhost:5001/api/v0/ls?arg=<hash>&stream-channels=true"
 
 **commands**
 
-### Level 2 Commands
-Level 2 commands are simply named spaced wrapped commands
-
 #### Config
 
 #### Update

package.json

@@ -38,9 +38,9 @@
     "gulp-filter": "^3.0.1",
     "gulp-git": "^1.6.0",
     "gulp-load-plugins": "^1.0.0",
-    "gulp-mocha": "^2.1.3",
     "gulp-size": "^2.0.0",
     "gulp-tag-version": "^1.3.0",
+    "gulp-spawn-mocha": "^2.2.1",
     "gulp-util": "^3.0.7",
     "https-browserify": "0.0.1",
     "ipfsd-ctl": "^0.6.1",

tasks/test.js

@@ -26,6 +26,15 @@ gulp.task('test:node', done => {
   )
 })
 
+gulp.task('docs', done => {
+  runSequence(
+    'daemons:start',
+    'mocha:docs',
+    'daemons:stop',
+    done
+  )
+})
+
 gulp.task('test:browser', done => {
   runSequence(
     'daemons:start',
@@ -39,10 +48,20 @@ gulp.task('mocha', () => {
   return gulp.src([
     'test/setup.js',
     'test/**/*.spec.js'
-  ])
-    .pipe($.mocha({
-      timeout: config.webpack.dev.timeout
-    }))
+  ]).pipe($.spawnMocha({
+    timeout: config.webpack.dev.timeout
+  }))
+})
+
+gulp.task('mocha:docs', function () {
+  return gulp.src([
+    'test/setup.js',
+    'test/**/*.spec.js'
+  ]).pipe($.spawnMocha({
+    timeout: config.webpack.dev.timeout,
+    reporter: 'markdown',
+    output: 'API.md'
+  }))
 })
 
 gulp.task('karma', done => {