YDoc 是一个优雅的文档站构建工具,能够基于 markdown 轻松生成完整静态站点,让你专注于文档写作。YDoc 拥有灵活而强大的插件 / 主题机制,开发者可以轻松定制属于自己的文档站点。
我们使用 🐶
作为我们的 LOGO,狗狗作为人类的好朋友,有着敏捷、灵动的特点:YDoc 正是这样一个工具 👻
npm install -g ydoc
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