Skip to content
master
Go to file
Code

Latest commit

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
bin
 
 
 
 
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

logo

YDoc

npm (tag) npm (tag) npm license

YDoc 是一个优雅的文档站构建工具,能够基于 markdown 轻松生成完整静态站点,让你专注于文档写作。YDoc 拥有灵活而强大的插件 / 主题机制,开发者可以轻松定制属于自己的文档站点。

我们使用 🐶 作为我们的 LOGO,狗狗作为人类的好朋友,有着敏捷、灵动的特点:YDoc 正是这样一个工具 👻

文档首页 | README in English

用法

安装

npm install -g ydoc

安装 rc 版本(发布候选版本)

npm install ydoc@rc [-g]

创建站点

ydoc init
ydoc build

插件

  • ydoc-plugin-copy: 用于快速复制 markdown 生成页面的代码片段。
  • ydoc-plugin-import-asset: 在页面中引入 js 与 css 文件
  • ydoc-plugin-jsdoc: 根据代码注释生成文档,基于 jsdoc
  • ydoc-plugin-pangu: 自动替你在网页中所有的中文字和半形的英文、数字、符号之间插入空白(盘古之白)
  • more...

主题

开发者

我们非常欢迎社区的同学参与开发,欢迎提 pull requests 来帮助我们完善程序,也欢迎社区的同学为 YDoc 开发插件。

同时也欢迎大家对 YDoc 提出宝贵的意见或建议:github issues

About

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

Topics

Resources

License

Packages

No packages published
You can’t perform that action at this time.