Skip to content

Latest commit

 

History

History
63 lines (45 loc) · 2.52 KB

README-en.md

File metadata and controls

63 lines (45 loc) · 2.52 KB

logo

YDoc

npm (tag) npm (tag) npm license

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

Themes

Developers

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