| 1 | ## 简介
|
| 2 |
|
| 3 | [](http://badge.fury.io/js/ydoc)
|
| 4 |
|
| 5 | 
|
| 6 |
|
| 7 | `YDoc` 是基于代码注释与 `markdown` 快速构建文档的工具，目前支持诸如：`React Native`, `JavaScript`, `CSS`, `SCSS` 等类别。
|
| 8 |
|
| 9 |
|
| 10 | ## 构建示例
|
| 11 |
|
| 12 | 想知道ydoc能构建什么样的文档吗？
|
| 13 |
|
| 14 | [ydoc-demo](https://github.com/YMFE/ydoc-demo) 展示了一些使用ydoc构建的文档案例，帮助您快速了解ydoc。
|
| 15 |
|
| 16 | ## 安装
|
| 17 |
|
| 18 | ```bash
|
| 19 | npm install ydoc [-g]
|
| 20 | ```
|
| 21 |
|
| 22 | ## 使用方式
|
| 23 |
|
| 24 | ### 使用命令方式
|
| 25 |
|
| 26 | * `cd /path/to/project/` 进入项目目录
|
| 27 | * `ydoc init` 初始化 YDoc 配置文件 ydoc.json（[配置说明](http://ydoc.ymfe.tech/usage.html#配置文件)）
|
| 28 | * `ydoc build` 构建文档，更多命令请查看（[构建命令](http://ydoc.ymfe.tech/usage.html#构建命令)）
|
| 29 |
|
| 30 |
|
| 31 | ### 使用其他方式
|
| 32 |
|
| 33 | 1. 使用脚本：
|
| 34 |
|
| 35 | ```javascript
|
| 36 | var ydoc = require("ydoc");
|
| 37 |
|
| 38 | ydoc.build('/path/to/project', options);
|
| 39 | ```
|
| 40 |
|
| 41 | 2. 使用Gulp：
|
| 42 |
|
| 43 | ```javascript
|
| 44 | var ydoc = require("ydoc");
|
| 45 |
|
| 46 | gulp.task('ydoc', function() {
|
| 47 | return gulp.src('./')
|
| 48 | .pipe(ydoc({
|
| 49 | // 配置
|
| 50 | }));
|
| 51 | });
|
| 52 | ```
|
| 53 |
|
| 54 | 3. 使用Grunt：
|
| 55 |
|
| 56 | ```javascript
|
| 57 | grunt.initConfig({
|
| 58 | ydoc: {
|
| 59 | // 配置
|
| 60 | }
|
| 61 | });
|
| 62 |
|
| 63 | grunt.loadNpmTasks('ydoc');
|
| 64 | ```
|
| 65 |
|
| 66 | ## 开发者
|
| 67 |
|
| 68 | * 林洋 <adwon.lin@qunar.com> | <edwon.lim@gmail.com>
|
| 69 | * 董文博 <wenbo.dong@qunar.com>
|
| 70 | * 王丽丽 <leila.wang@qunar.com>
|