建站技术 有时候需要给 Saas 软件加个文档功能,分享一下我的收藏

hfpp2012 · 2021年12月01日 · 70 次阅读

awesome-microservices

如何才能写出简洁好看的 API 文档,有没有开源框架可以用?

基于 Markdown 编写接口文档

apiblueprint

可以用 netlify 随便迁移

比如:https://suifeng-blog.netlify.com/

1. slate

https://github.com/lord/slate

middleman 写的

2. sphinx-doc

http://www.sphinx-doc.org/en/stable/

3. gitbook 如何自己搭

https://www.gitbook.com/

https://github.com/MagLoft/gitbook-plugin-api api

http://plugins.gitbook.com/

所有插件 http://www.tuicool.com/articles/zee2ui

https://developer.gitbook.com/# 生成 api

GitbookIO/developer.gitbook.com

GitbookIO/theme-api

# 生成pdf gitbook pdf
ln -s /Applications/calibre.app/Contents/MacOS/ebook-convert /usr/local/bin

Gitbook 的使用和常用插件

4. mdBook

https://github.com/azerupi/mdBook rust 写的 类似于 gitbook

5. hugo + docuapi

https://github.com/spf13/hugo + https://themes.gohugo.io/docuapi/

https://github.com/bep/docuapi

https://themes.gohugo.io/hugo-theme-learn/ 不错

语法高亮:https://gohugo.io/extras/highlighting/

6. mkdocs

http://www.mkdocs.org/

7. rocadocs

http://rocadocs.com/

8. graphql

https://github.com/graphql/graphql.github.io

9. MinDoc

https://github.com/lifei6671/godoc

10. swagger-ui

https://github.com/swagger-api/swagger-ui

https://docs.docker.com/engine/api/v1.27/

docker run -p 80:8080 swaggerapi/swagger-ui

11. hexo 官网

http://create.hanc.cc/ 微信机器人

https://hexo.io/zh-cn/ 中文

https://github.com/hexojs/site

https://github.com/zalando-incubator/hexo-theme-doc

https://git.oschina.net/star7th/showdoc

12. 看云

https://help.kancloud.cn/41497

13 .netlify 可以放源码

14 react

15 https://github.com/vuejs/vuepress

16 https://yuque.com/

17 https://github.com/docsifyjs/docsify

其他

Rails 用 Rails 写后端 API,请问有什么自动生成 API 文档 的 gem 吗

开发工具 写 API 文档有什么好工具?

72pulses/apidoco

rswag/rswag

文档

GitbookIO/gitbook

https://toolchain.gitbook.com/setup.html 官方文档

http://www.chengweiyang.cn/gitbook/installation/README.html

https://chrisniael.gitbooks.io/gitbook-documentation/content/ GitBook 文档(中文版)

https://cowmanchiang.me/gitbook/gitbook/contents/gitbook.html

暂无回复。
需要 登录 后方可回复, 如果你还没有账号请点击这里 注册