q-doc

1.0.0-beta7 • Public • Published

QDoc

简介

前端工程文档生成工具

npm version

安装

npm install q-doc [-g]

使用方式

命令

cd /path/to/project/
qdoc build

详细请查看命令使用说明

脚本

var qdoc = require("q-doc");
 
qdoc.build('/path/to/project', options);

Gulp

var qdoc = require("q-doc");
 
gulp.task('qdoc', function() {
    return gulp.src('./')
        .pipe(qdoc({
            // 配置
        }));
});

Grunt

grunt.initConfig({
    qdoc: {
        // 配置
    }
});
 
grunt.loadNpmTasks('q-doc');

配置及配置文件请查看 配置说明;

开发者

林洋 adwon.lin@qunar.com

Readme

Keywords

none

Package Sidebar

Install

npm i q-doc

Weekly Downloads

1

Version

1.0.0-beta7

License

BSD

Last publish

Collaborators

  • edwonlim