小团队的相关文档如果想部署成网页应该用什么方案?

2022-11-17 12:08:43 +08:00
 ggp1ot2

团队内想把之前开发的一些接口、相关代码整理成文档。

已经分类别写了很多个 markdown 文件。

我可以使用一些基于 Sphinx 的工具,将这些 markdown 渲染成网页格式发布。

但是还有一些其他的问题让我暂时没想到好的方案。

一个是为了防止泄漏,在进入网页前,需要有个页面去输入账号密码验证

我直接用框架弄出来的就是一个一个的 html ,点击就打开了,如果还需要加登陆页,我想到的就是再单独找一个登陆页的 html ,然后用 Django 什么的,手动一个一个把上面生成的 html 搞成子页面,感觉太麻烦。

当然,也不一定必须是要额外添加一个面,只是需要一个方法来控制只有团队内部或者拥有指定口令的人才能访问,如果还能额外有个页面管理就更好了。

所以就像这样的需求 [将 markdown 转成 html 并且还能支持指定人查看] 有没有什么更好的方案?

4137 次点击
所在节点    程序员
32 条回复
coderge
2022-11-17 15:29:16 +08:00
`语雀`也不错, 可以整理团队知识库, 开发文档之类的.
mouyong
2022-11-17 17:41:44 +08:00
mouyong
2022-11-17 17:42:50 +08:00
nginx basic 认证加上 #22 文档站应该可以满足
xylophone21
2022-11-17 17:49:42 +08:00
装个 gitlab?
AmberMmoe
2022-11-17 19:14:50 +08:00
mkdocs ,或者 facebook 那个小恐龙,都挺好用的
RheatiN
2022-11-17 22:21:03 +08:00
docusaurus ,好看又简单
Herry001
2022-11-17 23:20:33 +08:00
是一个简单的账号验证就行(登陆后没有权限组,全部都能看),还是说要一个带权限组的?
前者用 Docsify 再加个认证就行,后者找个 Wiki 系统(比如 BookStack )。
star7th
2022-11-18 10:46:48 +08:00
建议使用 showdoc https://github.com/star7th/showdoc 开源免费私有部署。
mosakashaka
2022-11-18 12:20:46 +08:00
spring ,加个登录验证,其他链接地址代理静态资源
litchinn
2022-11-18 17:25:39 +08:00
zed1018
2022-11-18 21:32:16 +08:00
其实我觉得小团队文档直接放私有 git 仓库就好了,别的我不知道,gitlab 的 markdown 渲染还是不错的,用 wiki 的话更好一些
Casbin
2022-11-21 19:58:26 +08:00
Showdoc 开源文档平台+Casdoor 开源单点登录系统

这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://www.v2ex.com/t/895898

V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX