https://github.com/ymfe/ydoc

🐶YDoc 是一个更懂你的文档站构建工具，基于 markdown 轻松生成完整静态站点
https://github.com/ymfe/ydoc

docs-generator jsdoc ydoc ymfe

Last synced: 7 days ago
JSON representation

🐶YDoc 是一个更懂你的文档站构建工具，基于 markdown 轻松生成完整静态站点

• Host: GitHub
• URL: https://github.com/ymfe/ydoc
• Owner: YMFE
• License: apache-2.0
• Created: 2016-05-30T09:06:57.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2021-01-08T03:57:03.000Z (almost 4 years ago)
• Last Synced: 2024-12-25T19:01:08.685Z (8 days ago)
• Topics: docs-generator, jsdoc, ydoc, ymfe
• Language: HTML
• Homepage: https://hellosean1025.github.io/ydoc
• Size: 30.4 MB
• Stars: 673
• Watchers: 33
• Forks: 123
• Open Issues: 8
• Metadata Files:
  • Readme: README-en.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  

    

  



## YDoc

![npm (tag)](https://img.shields.io/npm/v/ydoc.svg)

![npm (tag)](https://img.shields.io/npm/v/ydoc/rc.svg)

![npm](https://img.shields.io/npm/dm/localeval.svg)

![license](https://img.shields.io/github/license/YMFE/ydoc.svg)

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](https://hellosean1025.github.io/ydoc/) | [中文 README](https://github.com/YMFE/ydoc/blob/master/README.md)

## 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](https://www.npmjs.com/package/ydoc-plugin-copy): Quickly copy the code snippet of the markdown generated page。

- [ydoc-plugin-import-asset](https://www.npmjs.com/package/ydoc-plugin-import-asset): Import js/css files in the page.

- [ydoc-plugin-jsdoc](https://www.npmjs.com/package/ydoc-plugin-jsdoc): Generate documents based on code comments, developed by 'jsdoc'

- [ydoc-plugin-pangu](https://www.npmjs.com/package/ydoc-plugin-pangu): 

Automatically insert space between all Chinese characters and half-size English, numbers, and symbols in your page.

- [more... ](https://hellosean1025.github.io/ydoc/plugin/index.html)

## Themes

- [ydoc-theme-demo](https://www.npmjs.com/package/ydoc-theme-demo)

- [ydoc-theme-dark](https://www.npmjs.com/package/ydoc-theme-dark)

## Developers

- [dwb1994](https://github.com/dwb1994) (dev & design)

- [lwg529](https://github.com/lwg529) (dev)

- [sean1025](https://github.com/hellosean1025) (dev)

- [zwjamnsss](https://github.com/amnsss) (dev & design)

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).

At the same time, we also welcome everyone's valuable comments or suggestions on YDoc: [github issues](https://github.com/YMFE/ydoc/issues)