对文档的编译,目前的发布方案是越来越注重 MD 的编辑和发布。
针对其他 Wiki 的选择,MD 文件的编辑通常会保留修改记录,同时不依赖中央数据库和其他类型的 Web 应用服务。
随着各大云平台的支持,包括 GitHub Page 和 Google 的 Firebase,通常在免费的情况下就可以获得基于自己域名的文档服务。
对文档内容的修改,也只需要修改 Md 文件就可以了。
Confluence
长期以来,我们都使用 Confluence 来作为我们的 Wiki 系统并且提供内部和外部的使用的。
通常因为 Confluence 有更好的用户授权,但是随着 Confluence 的生命周期的总结,官方要求要不就使用他们的云服务,要不就要自己部署一套云解决方案。
对我们来说这个没有意义,所以我们需要为我们项目中已经公开的文档提供一个归档和方案。
这次,我们决定使用 md 的文档格式,所以我们考虑在 Docsify 和 Hugo 之间进行选型。
Docsify
Docsify 主打的就是一个简单。
对个人用户来说,使用 Docsify 是非常好的选择,这个能让个人只专注内容的,而不需要考虑复杂的配置。
例如,上面我们使用的文档工具,对我们来说就暂时足够了,但是在框架的配置上,我们还是觉得过于简单了。
Hugo
Hugo 能够做出非常漂亮的文档。
例如 pulumi 的官方文档就是用 Hugo 做出来了。
可以说,这个文档有非常高的水平了,无论从配色还是其他方面来说都非常漂亮。
如果你是公司,并且有足够的技术力量的话,Hugo 通常是你非常好的选择。
部署
上面 2 个平台,都能够使用无服务的方式进行部署。
我们用 pulumi 的文档测试编译后在 Google Firebase 上进行部署。
也能够实现一键部署,能够让用户只专注代码和内容,而不需要专注部署。
总结
如果是个人使用,在前端和技术能力也不是非常强的情况下,建议使用 Docsify ,因为我们还是需要更多的关注内容。
如果有一定发展规模,并且技术力量足够的情况下,可以使用 Hugo,因为 Hugo 能够提供更多的复杂功能,但是又不会过多增加技术难度。
Docsify 和 Hugo 之间的选型 - 文档交付 - iSharkFly对文档的编译,目前的发布方案是越来越注重 MD 的编辑和发布。 针对其他 Wiki 的选择,MD 文件的编辑通常会保留修改记录,同时不依赖中央数据库和其他类型的 Web 应用服务。 随着各大云平台的支持,包括 GitHub Page 和 Google 的 Firebase,通常在免费的情况下就可以获得基于自己域名的文档服务。 对文档内容的修改,也只需要修改 Md 文件就可以了。 Confluence长期以来,我们都使用 Con…https://www.isharkfly.com/t/docsify-hugo/15115