node package manager
Loosely couple your services. Use Orgs to version and reuse your code. Create a free org »

ydoc

简介

npm version

YDoc 是基于代码注释与 markdown 快速构建文档的工具,目前支持诸如:React Native, JavaScript, CSS, SCSS 等类别。

构建示例

想知道ydoc能构建什么样的文档吗?

ydoc-demo 展示了一些使用ydoc构建的文档案例,帮助您快速了解ydoc。

安装

npm install ydoc [-g]

使用方式

使用命令方式

  • cd /path/to/project/ 进入项目目录
  • ydoc init 初始化 YDoc 配置文件 ydoc.json(配置说明
  • ydoc build 构建文档,更多命令请查看(构建命令

使用其他方式

  1. 使用脚本:

    var ydoc = require("ydoc");
     
    ydoc.build('/path/to/project', options);
  2. 使用Gulp:

    var ydoc = require("ydoc");
     
    gulp.task('ydoc', function() {
        return gulp.src('./')
            .pipe(ydoc({
                // 配置
            }));
    });
  3. 使用Grunt:

    grunt.initConfig({
        ydoc: {
            // 配置
        }
    });
     
    grunt.loadNpmTasks('ydoc');

开发者