YMFE/ydoc

YDoc

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.

YDoc has a flexible and powerful plugin/theme mechanism that allows developers to easily customize their own documentation site.

We use 🐶 as our LOGO. Dogs are good friends of human beings, and they are nimble and agile: YDoc is such a tool.

Homepage | 中文 README

Usage

install

npm install -g ydoc

install the rc version (Release Candidate)

npm install ydoc@rc [-g]

build

ydoc init
ydoc build

Plugins

• ydoc-plugin-copy: Quickly copy the code snippet of the markdown generated page。
• ydoc-plugin-import-asset: Import js/css files in the page.
• ydoc-plugin-jsdoc: Generate documents based on code comments, developed by 'jsdoc'
• ydoc-plugin-pangu: Automatically insert space between all Chinese characters and half-size English, numbers, and symbols in your page.
• more...

Themes

• ydoc-theme-demo
• ydoc-theme-dark

Developers

• dwb1994 (dev & design)
• lwg529 (dev)
• sean1025 (dev)
• zwjamnsss (dev & design)

We welcome all of you to participate in our development, you may submit pull requests to help us improve the program, we alse glad to see you help developing plugins.

At the same time, we also welcome everyone's valuable comments or suggestions on YDoc: github issues