https://github.com/ymfe/ydoc-demo

sample application of ydoc
https://github.com/ymfe/ydoc-demo

ydoc ydoc-demo

Last synced: 3 months ago
JSON representation

sample application of ydoc

• Host: GitHub
• URL: https://github.com/ymfe/ydoc-demo
• Owner: YMFE
• Created: 2017-06-16T08:07:46.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2017-08-16T07:45:30.000Z (almost 9 years ago)
• Last Synced: 2025-02-18T01:43:13.484Z (over 1 year ago)
• Topics: ydoc, ydoc-demo
• Size: 1.82 MB
• Stars: 4
• Watchers: 11
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
## 链接

- [YDoc 首页](http://ydoc.ymfe.tech/)

- [YDoc Github](https://github.com/YMFE/ydoc)

- [YDoc NPM](https://www.npmjs.com/package/ydoc)

## 简介

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

这里展示了YDoc的几个构建示例, 请将项目clone到本地进行查看。

## 构建示例

请进入下列文件夹以查看对应示例：

| 文件夹名称      | 示例内容         | 详情  |

| :-----------  |:-------------   | :-----|

| hello-world   | 基本配置         | 最基础的配置                           |

| page          | 注释/md         | 示范注释/md解析的所有规则生成的页面        |

| extension     | 扩展            | 配置自定义的css、js、img等文件           |

| sidenav       | 侧栏            | 示范侧栏的各种呈现方式                   |

| homepage      | 首页            | 自定义首页                             |

| multifiles    |在页面中使用多个文件| 在同一页面中组合使用多个文件              |

| `*doc`          | 多版本切换        | 示范多版本切换                        |

`*` 注意： 查看多版本切换功能示例需要使用git切换到 `doc` 分支。