建议阅读本文的英文版: Announcing Docmate
对我来说,文档和代码同等重要,如果写出来的代码没有写文档,那么等于没写代码。互联网上有很多文档平台,但有些团队或公司会基于数据安全的考虑不能使用外部平台,只好通过自建的 Gitlab Wiki 或者其它一些开源的 wiki system 解决文档问题,或者用一些静态文档生成工具配合 Gitlab 生成文档。
我调研了一些开源的 wiki system, 发现国外开源的 wiki system 对中文内容并不友好,尤其是在内容组织上,基于 slug 来编排目录对于中文标题来说是非常困难的. 国内的开源 wiki system 相对比较少,所以这些天,作为一个 Side Project, 我尝试按照自己的思路做出来了 Docmate.
1.编写 Markdown 文档,得到可以分享的 Docute 或 Docsify (暂不支持) 文档
2.建立团队,邀请团队成员,共同维护文档
3.文档可以设置为仅团队成员可见
Docmate 分为 Docmate Cloud 和自己部署的 Docmate, 两者功能目前完全相同。你可以按照官方文档部署自己的 Docmate, 也可以在 https://docmate.io 可以直接使用 Docmate Cloud. 所有功能暂时不收取费用。
1.对数据安全敏感、希望自己部署文档库的团队
2.工具开发者,需要给用户编写使用手册,可以直接使用 Docmate Cloud
在团队合作中,编写文档是软件工程师很重要的素养,我希望 Docmate 能给需要文档库的团队多一个选择,让更多工程师愿意编写文档。
还有很多计划中的功能尚未完成,包括:
另外,在代码结构稳定后,我将开源全部代码。
1
djyde OP 有没有设计师有兴趣 Redesign 一下?欢迎联系。
|
2
a132811 2020-08-15 18:38:27 +08:00
支持 math/latex 、表格、流程图 吗?
|
3
xcatliu 2020-08-15 18:40:42 +08:00 via iPhone
感觉不错,支持!
|
4
connection 2020-08-17 20:03:12 +08:00
赞
|
5
touno 2020-08-18 10:07:15 +08:00 2
惯例先吐槽一下:因为对中文支持不友好~so~做了这个东西,然后这个东西全是英文...尴尬不~
|
6
yuanfnadi 2020-08-20 00:05:12 +08:00
个人倾向于 dumi
|
7
Terry05 2021-02-14 23:17:46 +08:00
这个项目已经没后续了么
|