YMFE / Ydoc
Licence: apache-2.0
🐶YDoc 是一个更懂你的文档站构建工具,基于 markdown 轻松生成完整静态站点
Stars: ✭ 566
Projects that are alternatives of or similar to Ydoc
examplejs
A tool for converting example code into test cases
Stars: ✭ 44 (-92.23%)
Mutual labels: jsdoc
Docma
A powerful tool to easily generate beautiful HTML documentation from JavaScript (JSDoc), Markdown and HTML files.
Stars: ✭ 287 (-49.29%)
Mutual labels: jsdoc
sveld
Generate TypeScript definitions for your Svelte components
Stars: ✭ 281 (-50.35%)
Mutual labels: jsdoc
Vscode Docthis
JSDoc generator extension for Visual Studio Code.
Stars: ✭ 284 (-49.82%)
Mutual labels: jsdoc
jsdoc-api
A programmatic interface for jsdoc3 with a few extra features
Stars: ✭ 55 (-90.28%)
Mutual labels: jsdoc
Compodoc
📔 The missing documentation tool for your Angular, Nest & Stencil application
Stars: ✭ 3,567 (+530.21%)
Mutual labels: jsdoc
hypatia
Convert JavaScript doctrings (in jsdoc AST format) to ijavascript Jupyter Notebooks
Stars: ✭ 12 (-97.88%)
Mutual labels: jsdoc
ts-lehre
Generate document block(JsDoc, EsDoc, TsDoc) from source code
Stars: ✭ 14 (-97.53%)
Mutual labels: jsdoc
Eslint Plugin Jsdoc
JSDoc specific linting rules for ESLint.
Stars: ✭ 516 (-8.83%)
Mutual labels: jsdoc
docgen
The docs.json generator for discord.js and its related projects
Stars: ✭ 59 (-89.58%)
Mutual labels: jsdoc
YDoc
YDoc 是一个优雅的文档站构建工具,能够基于 markdown 轻松生成完整静态站点,让你专注于文档写作。YDoc 拥有灵活而强大的插件 / 主题机制,开发者可以轻松定制属于自己的文档站点。
我们使用 🐶
作为我们的 LOGO,狗狗作为人类的好朋友,有着敏捷、灵动的特点:YDoc 正是这样一个工具 👻
用法
安装
npm install -g ydoc
安装 rc 版本(发布候选版本)
npm install [email protected] [-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
Note that the project description data, including the texts, logos, images, and/or trademarks,
for each open source project belongs to its rightful owner.
If you wish to add or remove any projects, please contact us at [email protected].