YDoc 优雅的文档站构建工具

Question

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

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

特点

优雅：经过精雕细琢，我们带给大家一个精心设计的、拥有卓越的视觉与交互体验的文档构建工具。
灵动：我们拥有非常灵活的 插件机制 与 主题定制 功能，正在努力构建活跃的插件社区。也许初次使用未见其惊艳，但当你灵活使用插件后便会发现她的强大。
简洁：以 ‘无形’ 代替 ‘有形’，从开发体验到用户界面的呈现，不断去除冗余的设计，使用户专注于写作与阅读。
开源：作为开源项目，我们拥有高质量的代码、完善的自动化测试流程，对社区的需求能够作出积极快速响应。

用法

安装

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: 自动替你在网页中所有的中文字和半形的英文、数字、符号之间插入空白(盘古之白)

主题

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

资源

• 官网：https://hellosean1025.github.io/ydoc/
• 中文教程：https://www.wenjiangs.com/docs/ydoc