1 | <p align="center">
|
2 | <a href="https://hellosean1025.github.io/ydoc/">
|
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 is an elegant document station construction tool that can easily generate complete static sites based on markdown, allowing you to focus on document writing.
|
15 |
|
16 | YDoc has a flexible and powerful plugin/theme mechanism that allows developers to easily customize their own documentation site.
|
17 |
|
18 | We use `🐶` as our LOGO. Dogs are good friends of human beings, and they are nimble and agile: YDoc is such a tool.
|
19 |
|
20 | [Homepage](https://hellosean1025.github.io/ydoc/) | [中文 README](https://github.com/YMFE/ydoc/blob/master/README.md)
|
21 |
|
22 | ## Usage
|
23 |
|
24 | #### install
|
25 | ```
|
26 | npm install -g ydoc
|
27 | ```
|
28 |
|
29 | ### install the rc version (Release Candidate)
|
30 | ```
|
31 | npm install ydoc@rc [-g]
|
32 | ```
|
33 |
|
34 | #### build
|
35 | ```
|
36 | ydoc init
|
37 | ydoc build
|
38 | ```
|
39 |
|
40 | ## Plugins
|
41 |
|
42 | - [ydoc-plugin-copy](https://www.npmjs.com/package/ydoc-plugin-copy): Quickly copy the code snippet of the markdown generated page。
|
43 | - [ydoc-plugin-import-asset](https://www.npmjs.com/package/ydoc-plugin-import-asset): Import js/css files in the page.
|
44 | - [ydoc-plugin-jsdoc](https://www.npmjs.com/package/ydoc-plugin-jsdoc): Generate documents based on code comments, developed by 'jsdoc'
|
45 | - [ydoc-plugin-pangu](https://www.npmjs.com/package/ydoc-plugin-pangu):
|
46 | Automatically insert space between all Chinese characters and half-size English, numbers, and symbols in your page.
|
47 | - [more... ](https://hellosean1025.github.io/ydoc/plugin/index.html)
|
48 |
|
49 | ## Themes
|
50 |
|
51 | - [ydoc-theme-demo](https://www.npmjs.com/package/ydoc-theme-demo)
|
52 | - [ydoc-theme-dark](https://www.npmjs.com/package/ydoc-theme-dark)
|
53 |
|
54 | ## Developers
|
55 |
|
56 | - [dwb1994](https://github.com/dwb1994) (dev & design)
|
57 | - [lwg529](https://github.com/lwg529) (dev)
|
58 | - [sean1025](https://github.com/hellosean1025) (dev)
|
59 | - [zwjamnsss](https://github.com/amnsss) (dev & design)
|
60 |
|
61 | We welcome all of you to participate in our development, you may submit [pull requests](https://github.com/YMFE/ydoc/pulls) to help us improve the program, we alse glad to see you help developing [plugins](https://hellosean1025.github.io/ydoc/plugin/index.html).
|
62 |
|
63 | At the same time, we also welcome everyone's valuable comments or suggestions on YDoc: [github issues](https://github.com/YMFE/ydoc/issues) |
\ | No newline at end of file |