Website: Documentation Site Generator

[hhstore]

related:

• website: landing page template #332

[hhstore]

文档展示:

• 搜索: https://github.com/topics/documentation-tool
• https://www.producthunt.com/alternatives/vuepress

VitePress:

• https://github.com/vuejs/vitepress
• https://vitejs.cn/vitepress/
• https://github.com/vuejs/vitepress
• 推荐: ⭐⭐⭐⭐⭐
• 使用 vite.

教程:

• https://cloud.tencent.com/developer/article/1912611

VuePress:(被上替代)

• https://github.com/vuejs/vuepress
• 基于 vue.js, vue 作者写的项目
• 推荐: ⭐⭐⭐⭐⭐
• https://vuepress.vuejs.org/zh/guide/#todo

部署说明:

• https://vuepress.vuejs.org/zh/guide/deploy.html#github-pages
• 支持 github page

dumi:

• https://github.com/umijs/dumi
• https://d.umijs.org/zh-CN/guide/advanced
• react
• 推荐: ⭐⭐⭐⭐⭐

Docusaurus:

• https://github.com/facebook/Docusaurus
• facebook 官方开源, fb家各种开源项目, 都是用他发布文档.
• 推荐: ⭐⭐
• 示例(项目文档自身,即示例): https://docusaurus.io/

docsify:

• https://github.com/docsifyjs/docsify
• 推荐: ⭐⭐⭐⭐⭐
• 文档UI漂亮
• 支持markdown, github hook 自动发布
• 项目中文文档: https://docsify.js.org/#/zh-cn/
• https://segmentfault.com/a/1190000007656679

theme 插件:

• https://github.com/xinlei3166/vitepress-theme-demoblock

部署说明:

• https://docsify.js.org/#/zh-cn/deploy
• 基于 github page

ydoc:

• https://github.com/YMFE/ydoc
• 去哪儿开源

docz:

• https://github.com/pedronauck/docz
• 示例: https://www.docz.site/

gatsby:

• https://github.com/gatsbyjs/gatsby
• react.js 项目

ReDoc:

• https://github.com/Rebilly/ReDoc
• swagger/open api 方式的文档

mkdocs:

• https://github.com/mkdocs/mkdocs
• python 项目

hugo:

• https://github.com/gohugoio/hugo

[hhstore]

API Mock / 展示:

yapi:

• 去哪儿前端: https://github.com/YMFE
• http://yapi.demo.qunar.com
• https://github.com/YMFE/yapi

apiDoc:

• https://github.com/apidoc/apidoc
• RESTful web API Documentation Generator
• 支持上传文件(example)

devdocs:

• https://github.com/freeCodeCamp/devdocs
• https://devdocs.io/
• 在线API文档合集

[hhstore]

其他:

prism

• https://github.com/PrismJS/prism
• https://prismjs.com/#languages-list
• 代码高亮插件, 支持全部开发语言

[hhstore]

Docusaurus 安装教程:

• https://docusaurus.io/docs/zh-CN/installation
• 版本依赖: Node> = 8.x 和 Yarn> = 1.5。

# 安装node:
brew install node

# 版本: v8.15.0
node -v

# 安装yarn:
npm install yarn


# 创建demo目录:
mkdir demo
cd demo/

# 安装项目初始化脚手架: 
npx docusaurus-init

# demo/
# 重命名: 
mv docs-examples-from-docusaurus docs

# 切换到内容目录: 
cd website/

# demo/website/
# 重命名:
mv blog-examples-from-docusaurus blog

# demo/website/
# 启动:
yarn start

• 访问: http://localhost:3000

配置:

多版本:

• https://docusaurus.io/docs/zh-CN/versioning

yarn run version 1.0.0

多语言:

• 多语言支持

• 代码高亮

• 参考示例: https://github.com/casbin/casbin-website/blob/master/website/siteConfig.js