Skip to content

Commit

Permalink
new toolchain for docs
Browse files Browse the repository at this point in the history
  • Loading branch information
maxkoryukov committed Feb 20, 2017
1 parent 812fad1 commit e06dc00
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 8 deletions.
41 changes: 33 additions & 8 deletions gulpfile.js
Original file line number Diff line number Diff line change
@@ -1,14 +1,17 @@
"use strict"

const argv = require("yargs").argv
const fs = require("fs")
const path = require("path")
const argv = require("yargs").argv
const mkdirp = require("mkdirp-bluebird")

const gulp = require("gulp")
const gulpIf = require("gulp-if")
const gulp = require("gulp")
const gulpIf = require("gulp-if")
const eslint = require("gulp-eslint")
const mocha = require("gulp-mocha")
const size = require("gulp-size")

const eslint = require("gulp-eslint")
const mocha = require("gulp-mocha")
const jsdoc = require("gulp-jsdoc3")
const size = require("gulp-size")
const jsdoc = require("gulp-jsdoc3")

const fix = !!argv.fix
const grep = argv.grep
Expand All @@ -27,7 +30,29 @@ const paths = {
],
}

gulp.task("doc", function D() { // eslint-disable-line prefer-arrow-callback
gulp.task("doc", function X() {
const jsdoc2md = require('jsdoc-to-markdown')
const docDir = path.join(__dirname, "book", "en", "code")

return mkdirp(docDir)
.then( () => {
return jsdoc2md.render({
files: 'src/**/*.js',
"name-format": false,
"module-index-format": "none",
"global-index-format": "table",
//"configure": ".jsdocrc.json",
"plugin": "dmd-gitbook",
"no-scope": false,
})
})
.then(output => {
return fs.writeFile(path.join(docDir, 'api.md'), output)
})
})

gulp.task("docold", function D() { // eslint-disable-line prefer-arrow-callback
// TODO: remove this task
return gulp.src(
"README.md", {
read: false,
Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@
"bluebird": "^3.4.7",
"chai": "^3.5.0",
"chai-json-schema": "^1.4.0",
"dmd-gitbook": "0.0.1",
"docdash": "^0.4.0",
"eslint": "^3.15.0",
"eslint-config-airbnb": "^14.1.0",
Expand Down

0 comments on commit e06dc00

Please sign in to comment.