团队内想把之前开发的一些接口、相关代码整理成文档。
已经分类别写了很多个 markdown 文件。
我可以使用一些基于 Sphinx 的工具,将这些 markdown 渲染成网页格式发布。
但是还有一些其他的问题让我暂时没想到好的方案。
一个是为了防止泄漏,在进入网页前,需要有个页面去输入账号密码验证。
我直接用框架弄出来的就是一个一个的 html ,点击就打开了,如果还需要加登陆页,我想到的就是再单独找一个登陆页的 html ,然后用 Django 什么的,手动一个一个把上面生成的 html 搞成子页面,感觉太麻烦。
当然,也不一定必须是要额外添加一个面,只是需要一个方法来控制只有团队内部或者拥有指定口令的人才能访问,如果还能额外有个页面管理就更好了。
所以就像这样的需求 [将 markdown 转成 html 并且还能支持指定人查看] 有没有什么更好的方案?
1
no13bus 2022-11-17 12:10:54 +08:00 1
showdoc
|
2
Aixiaoa 2022-11-17 12:11:11 +08:00 via iPhone
搜索 静态博客 有的会带秘密访问 或者 随便一个静态生成器加 traefik 之类的。由 traefik 做密码
|
3
Les1ie 2022-11-17 12:13:47 +08:00
|
4
mango88 2022-11-17 12:48:00 +08:00
套个 nginx 用 basic auth
|
5
zhhanging 2022-11-17 12:49:08 +08:00
wiki.js 可以吗
|
6
tt0411 2022-11-17 12:52:09 +08:00
|
7
asdjgfr 2022-11-17 13:17:05 +08:00
本地部署一套 wiki.js ,完全符合你的需求。https://js.wiki/
|
8
nsynet57 2022-11-17 13:26:43 +08:00 via Android
考虑文档常常要更新,最好用 wiki 方式
|
9
beichenshao 2022-11-17 13:28:58 +08:00
部署成网页,对于你们来说,是个伪需求,你们希望的是做文档预览和权限管理,其实用飞书云文档就好了,md 文件上传直接预览,还可以直接转成在线文档,对于权限管理,飞书文档做的也非常好,然后直接注册使用即可,无部署,小团队无收费。
|
10
tool2d 2022-11-17 13:40:54 +08:00 via Android
这个需求,路由验证 cookie 可以轻松做到吧。
问问你们后端吧,就几行代码的事情。 |
11
clf 2022-11-17 13:42:02 +08:00
需要密码访问的话,直接 nginx 加一个基础的身份认证就行了。
|
12
clf 2022-11-17 13:43:58 +08:00
如果想要比较正常的登录页面。可以用 logto 封一层。目前我司就是用 logto 进行登录验证,然后访问不同的页面。
|
13
Phiiiil 2022-11-17 13:53:06 +08:00 via iPhone
推荐一个自用的 markdown 程序,轻量化,部署简单,https://github.com/gaowei-space/markdown-blog
目前不支持登录验证,可以通过 nginx 把站点改为仅内网访问、固定 I P 访问 |
14
amrice 2022-11-17 13:56:59 +08:00
github pages+markdown
|
17
SenLief 2022-11-17 14:06:54 +08:00
内网搭建一个 wiki ,如果没那么高的要求,用 notion ,飞书一类的就好了。
|
18
ggp1ot2 OP @beichenshao #9 并不是伪需求,换句话说,也算伪需求,只不过网页格式最合适。飞书云文档以及语雀等工具不是没考虑过,首先要求对方都有飞书账号,我们公司从某种意义上也是某节跳动竞争对手,所以绝不可能用相关工具,另外有些文档内包含比较隐私的例如 IP 、密码什么的,领导肯定不同意内容放在别人的服务器上
|
19
play78 2022-11-17 14:10:35 +08:00
这个我刚好做过。 文档是 sphinx 实现的。
认证是通过 nginx + lua script 来实现。 利用 luascript 发送给公司某应用服务器,实现单点登录。还可以为每个文件设置权限。利用已有的系统进行认证,不用每个人还需要再分配账号密码。 |
20
youyi1996 2022-11-17 14:14:18 +08:00
Docsify + HTTP Basic Auth 呗,无需转换 Markdown 至 HTML
缺点是某些手机 APP 里的浏览器框架不会弹出登录对话框,比如毒瘤 Wechat |
21
coderge 2022-11-17 15:29:16 +08:00
`语雀`也不错, 可以整理团队知识库, 开发文档之类的.
|
22
mouyong 2022-11-17 17:41:44 +08:00
|
23
mouyong 2022-11-17 17:42:50 +08:00
nginx basic 认证加上 #22 文档站应该可以满足
|
24
xylophone21 2022-11-17 17:49:42 +08:00
装个 gitlab?
|
25
AmberMmoe 2022-11-17 19:14:50 +08:00
mkdocs ,或者 facebook 那个小恐龙,都挺好用的
|
26
RheatiN 2022-11-17 22:21:03 +08:00
docusaurus ,好看又简单
|
27
Herry001 2022-11-17 23:20:33 +08:00
是一个简单的账号验证就行(登陆后没有权限组,全部都能看),还是说要一个带权限组的?
前者用 Docsify 再加个认证就行,后者找个 Wiki 系统(比如 BookStack )。 |
28
star7th 2022-11-18 10:46:48 +08:00
建议使用 showdoc https://github.com/star7th/showdoc 开源免费私有部署。
|
29
mosakashaka 2022-11-18 12:20:46 +08:00
spring ,加个登录验证,其他链接地址代理静态资源
|
30
litchinn 2022-11-18 17:25:39 +08:00
|
31
zed1018 2022-11-18 21:32:16 +08:00
其实我觉得小团队文档直接放私有 git 仓库就好了,别的我不知道,gitlab 的 markdown 渲染还是不错的,用 wiki 的话更好一些
|
32
Casbin 2022-11-21 19:58:26 +08:00
Showdoc 开源文档平台+Casdoor 开源单点登录系统
|