YDoc是基于项目代码注释与markdown快速构建文档的工具,目前支持诸如:React Native, JavaScript, CSS, SCSS 等类别。
这里展示了YDoc的几个构建示例, 请将项目clone到本地进行查看。
请进入下列文件夹以查看对应示例:
| 文件夹名称 | 示例内容 | 详情 |
|---|---|---|
| hello-world | 基本配置 | 最基础的配置 |
| page | 注释/md | 示范注释/md解析的所有规则生成的页面 |
| extension | 扩展 | 配置自定义的css、js、img等文件 |
| sidenav | 侧栏 | 示范侧栏的各种呈现方式 |
| homepage | 首页 | 自定义首页 |
| multifiles | 在页面中使用多个文件 | 在同一页面中组合使用多个文件 |
*doc | 多版本切换 | 示范多版本切换 |
* 注意: 查看多版本切换功能示例需要使用git切换到 doc 分支。