JavaScript jsdoc-to-markdown示例

示例#1

    return through.obj(function(file, enc, callback) {
        var self = this;

        if (file.isNull()) {
           // Do nothing if no contents
        }
        if (file.isBuffer()) {
            var buf = new Buffer(0);
            var jsdoc2mdStream = jsdoc2md(options);
            jsdoc2mdStream.on("readable", function(){
                var chunk = this.read();
                if (chunk) buf = Buffer.concat([ buf, chunk ]);
            });
            jsdoc2mdStream.on("end", function(){
                file.contents = buf;
                self.push(file);
                return callback();
            });
            jsdoc2mdStream.on("error", function(err){
                self.emit("error", new PluginError(PLUGIN_NAME, err.message));
            });
            jsdoc2mdStream.end(file.contents);
        }

        if (file.isStream()) {
            file.contents = file.contents.pipe(jsdoc2md(options));
            self.push(file);
            return callback();
        }
    });

示例#2

文件： gulpfile.js 项目： jhamlet/protean

gulp.task('api.md', function () {
    return jsdoc2md({
        src: PATHS,
        'header-depth': 4
    }).
        pipe(fs.createWriteStream('api.md'));
});

示例#3

文件： gulpfile.js 项目： IvanGaravito/node-usererror

gulp.task('docs', function () {
  jsdoc2md({
    src: 'index.js',
    template: fs.readFileSync('./docs/README.hbs', 'utf8')
  })
  .on('error', console.error)
  .pipe(fs.createWriteStream('README.md'))
})

示例#4

文件： gulpfile.js 项目： Bindez/koa-router

gulp.task('docs', function () {
  jsdoc2md({
    src: './lib/*.js',
    template: fs.readFileSync('./lib/README_tpl.hbs', 'utf8')
  })
  .on('error', function(err){
    console.log(err);
  })
  .pipe(fs.createWriteStream('README.md'));
});

示例#5

文件： generate.js 项目： klowdo/octopusApi

 fs.writeFile(jsfile,beautify(file, { indent_size: 2 }),(err)=>{
   jsdoc2md({ src: jsfile}).pipe(fs.createWriteStream('readme.md'))
 })

示例#6

文件： generator.js 项目： schahriar/OpenFeedback

'use strict'

var fs = require('fs');
var path = require('path');
var render = require('jsdoc-to-markdown');
var stream = fs.createWriteStream("./documentation/API.md");

render({
    src: [path.resolve(__dirname, '../core/', 'OpenFeedback.js')],
    separators: true
}).pipe(stream);