当前位置: 首页 > news >正文

Docsify 和 Hugo 之间的选型

对文档的编译,目前的发布方案是越来越注重 MD 的编辑和发布。

针对其他 Wiki 的选择,MD 文件的编辑通常会保留修改记录,同时不依赖中央数据库和其他类型的 Web 应用服务。

随着各大云平台的支持,包括 GitHub Page 和 Google 的 Firebase,通常在免费的情况下就可以获得基于自己域名的文档服务。

对文档内容的修改,也只需要修改 Md 文件就可以了。

Confluence

长期以来,我们都使用 Confluence 来作为我们的 Wiki 系统并且提供内部和外部的使用的。

通常因为 Confluence 有更好的用户授权,但是随着 Confluence 的生命周期的总结,官方要求要不就使用他们的云服务,要不就要自己部署一套云解决方案。

对我们来说这个没有意义,所以我们需要为我们项目中已经公开的文档提供一个归档和方案。

这次,我们决定使用 md 的文档格式,所以我们考虑在 Docsify 和 Hugo 之间进行选型。

Docsify

Docsify 主打的就是一个简单。

对个人用户来说,使用 Docsify 是非常好的选择,这个能让个人只专注内容的,而不需要考虑复杂的配置。

2023-11-08_11-00-02

例如,上面我们使用的文档工具,对我们来说就暂时足够了,但是在框架的配置上,我们还是觉得过于简单了。

Hugo

Hugo 能够做出非常漂亮的文档。

例如 pulumi 的官方文档就是用 Hugo 做出来了。

可以说,这个文档有非常高的水平了,无论从配色还是其他方面来说都非常漂亮。

2023-11-08_11-01-17

如果你是公司,并且有足够的技术力量的话,Hugo 通常是你非常好的选择。

部署

上面 2 个平台,都能够使用无服务的方式进行部署。

我们用 pulumi 的文档测试编译后在 Google Firebase 上进行部署。

也能够实现一键部署,能够让用户只专注代码和内容,而不需要专注部署。

总结

如果是个人使用,在前端和技术能力也不是非常强的情况下,建议使用 Docsify ,因为我们还是需要更多的关注内容。

如果有一定发展规模,并且技术力量足够的情况下,可以使用 Hugo,因为 Hugo 能够提供更多的复杂功能,但是又不会过多增加技术难度。

Docsify 和 Hugo 之间的选型 - 文档交付 - iSharkFly对文档的编译,目前的发布方案是越来越注重 MD 的编辑和发布。 针对其他 Wiki 的选择,MD 文件的编辑通常会保留修改记录,同时不依赖中央数据库和其他类型的 Web 应用服务。 随着各大云平台的支持,包括 GitHub Page 和 Google 的 Firebase,通常在免费的情况下就可以获得基于自己域名的文档服务。 对文档内容的修改,也只需要修改 Md 文件就可以了。 Confluence长期以来,我们都使用 Con…icon-default.png?t=N7T8https://www.isharkfly.com/t/docsify-hugo/15115

http://www.lryc.cn/news/223163.html

相关文章:

  • 第二十章 ObjectScript 应用程序中的数值计算 - 转换:十进制到 $DOUBLE
  • C语言【趣编程】我们怎样便捷输出空心的金字塔
  • 《JavaScript设计模式》笔记 - - - 超全设计模式概览
  • 浅谈Vue 3的响应式对象: ref和reactive
  • 怎么学编程效率高,编程练习网站编程软件下载,中文编程开发语言工具下载
  • Alphago Zero的原理及实现:Mastering the game of Go without human knowledge
  • STM32 堆栈空间分布
  • 小程序制作(超详解!!!)第十五节 自动随机变化的三色旗
  • MySQL_主从复制_环境搭建
  • Linux 设置静态IP(Ubuntu 20.04/18.04)
  • 计网----累积应答,TCP的流量控制--滑动窗口,粘包问题,心跳机制,Nagle算法,拥塞控制,TCP协议总结,UDP和TCP对比,中介者模式
  • OpenCV 直方图和归一化
  • Flink架构
  • Packet Tracer路由器连接终端设备怎么配置?
  • 评估APP网页小程序代码UI开发H5估价师怎么评估开发精确研发价格?
  • 16 Linux 内核定时器
  • C++11 shared_ptr类型智能指针学习
  • 网络流量分类概述
  • JavaWeb篇_02——服务器简介及Tomcat服务器简介
  • 2311d游戏引擎适配ios
  • 网络唤醒(Wake-on-LAN, WOL)
  • 接口测试框架实战(一) | Requests 与接口请求构造
  • 【C++】详解 void*
  • Linux家目录变成了-bash-4.2$
  • Python和SQLite游标处理多行数据
  • 安全测试之PHP 漏洞全解
  • 【bug-maven】(一)java: 错误: 不支持发行版本 5 (二):java: 错误: 无效的源发行版:15
  • git命令大全(附使用步骤+注释)
  • 【论文阅读】Progressive Spatio-Temporal Prototype Matching for Text-Video Retrieval
  • python --- 类与对象(二)