1 | <p align="center">
|
2 | <a href="https://ydoc.ymfe.org/">
|
3 | <img src="https://ws1.sinaimg.cn/large/006FkmqZly1fpswv9gzalj305e05ft98.jpg" width="194" alt="logo" srcSet="https://ws1.sinaimg.cn/large/006FkmqZly1fpswvk5qsyj30as0au75x.jpg 2x" />
|
4 | </a>
|
5 | </p>
|
6 |
|
7 | ## YDoc
|
8 |
|
9 | ![npm (tag)](https://img.shields.io/npm/v/ydoc.svg)
|
10 | ![npm (tag)](https://img.shields.io/npm/v/ydoc/rc.svg)
|
11 | ![npm](https://img.shields.io/npm/dm/localeval.svg)
|
12 | ![license](https://img.shields.io/github/license/YMFE/ydoc.svg)
|
13 |
|
14 | YDoc 是一个优雅的文档站构建工具,能够基于 markdown 轻松生成完整静态站点,让你专注于文档写作。YDoc 拥有灵活而强大的插件 / 主题机制,开发者可以轻松定制属于自己的文档站点。
|
15 |
|
16 | 我们使用 `🐶` 作为我们的 LOGO,狗狗作为人类的好朋友,有着敏捷、灵动的特点:YDoc 正是这样一个工具 👻
|
17 |
|
18 | [文档首页](https://ydoc.ymfe.org/) | [README in English](https://github.com/YMFE/ydoc/blob/master/README-en.md)
|
19 |
|
20 | ## 用法
|
21 |
|
22 | ### 安装
|
23 | ```
|
24 | npm install -g ydoc
|
25 | ```
|
26 |
|
27 | ### 安装 rc 版本(发布候选版本)
|
28 | ```
|
29 | npm install ydoc@rc [-g]
|
30 | ```
|
31 |
|
32 | ## 创建站点
|
33 | ```
|
34 | ydoc init
|
35 | ydoc build
|
36 | ```
|
37 |
|
38 | ## 插件
|
39 |
|
40 | - [ydoc-plugin-copy](https://www.npmjs.com/package/ydoc-plugin-copy): 用于快速复制 markdown 生成页面的代码片段。
|
41 | - [ydoc-plugin-import-asset](https://www.npmjs.com/package/ydoc-plugin-import-asset): 在页面中引入 js 与 css 文件
|
42 | - [ydoc-plugin-jsdoc](https://www.npmjs.com/package/ydoc-plugin-jsdoc): 根据代码注释生成文档,基于 jsdoc
|
43 | - [ydoc-plugin-pangu](https://www.npmjs.com/package/ydoc-plugin-pangu): 自动替你在网页中所有的中文字和半形的英文、数字、符号之间插入空白(盘古之白)
|
44 | - [more... ](https://ydoc.ymfe.org/plugin/index.html)
|
45 |
|
46 | ## 开发者
|
47 |
|
48 | - [dwb1994](https://github.com/dwb1994) (dev & design)
|
49 | - [sean1025](https://github.com/hellosean1025) (dev)
|
50 | - [zwjamnsss](https://github.com/amnsss) (dev & design)
|
51 |
|
52 | 我们非常欢迎社区的同学参与开发,欢迎提 [pull requests](https://github.com/YMFE/ydoc/pulls) 来帮助我们完善程序,也欢迎社区的同学为 YDoc 开发[插件](https://ydoc.ymfe.org/plugin/index.html)。
|
53 |
|
54 | 同时也欢迎大家对 YDoc 提出宝贵的意见或建议:[github issues](https://github.com/YMFE/ydoc/issues)
|