前端文档生成框架

背景

有时候写项目难免要用到文档框架。

可选项

VitePress/VuePress

熟悉的vue,不必多说。
https://vitepress.dev/zh/

docsify

28.2k stars
https://docsify.js.org/#/zh-cn/
知名度很高。

其服务端渲染的功能目前已经被废弃,需要等待后续版本。

docusaurus

57.4k stars
facebook出品,基于react。
https://docusaurus.io/zh-CN/

StoryBook

85k stars
https://storybook.js.org/
直接开发了一个应用用于构建文档,看着都觉得nb。

showDoc

12.3k stars

用于团队协作的,有登录功能,不是纯静态。

https://www.showdoc.com.cn/

不推荐

docz(不推荐)

23.7k stars
使用react构建。
有2年没有更新了,没有面向未来的生态。
image

styleguidist(不推荐)

也是使用react的。
https://react-styleguidist.js.org/

docute

https://github.com/egoist/docute

冷门

MinDoc

7.4k stars
这个是需要服务器的,后端接口文档。
https://mindoc.com.cn/docs/mindochelp

BookStack

基于MinDoc的
https://github.com/truthhun/BookStack

wizard

2.2k stars
https://github.com/mylxsw/wizard

kooteam

团队协作工具,不用猜都知道是要服务器
https://gitee.com/yimiyisu/kooteam

总结

作为自由人,肯定是有新的用新的,有好看的用好看的。

posted @ 2024-12-25 18:12  魂祈梦  阅读(123)  评论(2)    收藏  举报