Docsify 和 Hugo 之间的选型

news2024/10/6 1:42:13

对文档的编译,目前的发布方案是越来越注重 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.coloradmin.cn/o/1187306.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

时序预测 | MATLAB实现WOA-CNN-LSTM-Attention时间序列预测(SE注意力机制)

时序预测 | MATLAB实现WOA-CNN-LSTM-Attention时间序列预测(SE注意力机制) 目录 时序预测 | MATLAB实现WOA-CNN-LSTM-Attention时间序列预测(SE注意力机制)预测效果基本描述模型描述程序设计参考资料 预测效果 基本描述 1.MATLAB实…

AI:72-基于深度学习的火灾检测

🚀 本文选自专栏:AI领域专栏 从基础到实践,深入了解算法、案例和最新趋势。无论你是初学者还是经验丰富的数据科学家,通过案例和项目实践,掌握核心概念和实用技能。每篇案例都包含代码实例,详细讲解供大家学习。 📌📌📌在这个漫长的过程,中途遇到了不少问题,但是…

【LeetCode刷题笔记】栈和队列

456. 132 模式 解题思路: 1. 单调递减栈,栈中存放的值当作 k 值,从右往左遍历数组,对于遇到的每一个元素 j 找最大的 k,遇到 nums[j] > 栈顶</

mysql explain type 枚举

explain 查看 sql 查询是否走索引。 其中 type 的枚举如下 类型说明system表只有一行&#xff08;系统表&#xff09;&#xff0c;这是 const 类型的特例const单表中的某个固定的值eq_ref使用唯一索引等值查找一个行ref使用非唯一索引查找所有匹配某个单个值的行fulltext使用…

如何摆脱自卑心理,自我提升和自我接纳是关键

自卑心理主要是由于缺乏对自己的客观评价&#xff0c;常常自我否定&#xff0c;缺乏自信心&#xff0c;不敢拿主意做决定&#xff0c;他们性格敏感&#xff0c;缺乏勇气&#xff0c;不敢发表自己的意见&#xff0c;总是将错误归结为自己不够好&#xff0c;不够努力等等。 适度…

多语言翻译软件 Mate Translate mac中文版特色功能

Mate Translate for Mac是一款多语言翻译软件&#xff0c;Mate Translate mac可以帮你翻译超过100种语言的单词和短语&#xff0c;使用文本到语音转换&#xff0c;并浏览历史上已经完成的翻译。你还可以使用Control S在弹出窗口中快速交换语言。 Mate Translate Mac版特色功能…

浅谈无线测温产品在马来西亚某配电项目的应用

摘要&#xff1a;配电系统是由多种配电设备和配电设施所组成的变换电压和直接向终端用户分配电能的一个电力网络系统。由于配电系统作为电力系统的一个环节直接面向终端用户&#xff0c;它的完善与否直接关系着广大用户的用电可靠性和用电质量&#xff0c;因而在电力系统中具有…

这些Mac视频格式转换神器,大赞666~

转换视频格式相信是很多朋友在平时工作和学习过程中的刚需&#xff0c;并且有很多人经常问小编这块的问题。 特别是一些使用Mac的朋友。 因此&#xff0c;小编今天就来给各位Mac用户安利几个好用的视频转换软件。 1、VideoProc VideoProc 功能强大&#xff0c;可以把视频甚…

适用于4D毫米波雷达的目标矩形框聚类

目录 一、前言 二、点云聚类分割 三、基于方位搜索L型拟合 四、评价准则之面积最小化 五、评价准则之贴合最大化 六、评价准则之方差最小化 一、前言 对于多线束雷达可以获取目标物体更全面的面貌,在道路中前向或角雷达可能无法获取目标车矩形框但可以扫到两边或者一边…

维控PLC——LX2N :编程口通讯协议

文章目录 说明通讯帧通讯命令字通讯数据地址维控 LX2N&#xff08;LX2V&#xff09;通讯协议举例 说明 该协议适用于维控LX2N系列PLC&#xff0c;关于维控 LX1S的协议在另一篇文章中描述。 通讯帧 通讯采用ASCII码&#xff0c;校验方式采用和校验。 请求帧格式:报文开始命令…

【计算机网络基础实验】实验二(补充内容)路由器的配置和静态路由

任务一 IP路由协议实现企业路由器通信 目录如下&#xff1a; 任务一 IP路由协议实现企业路由器通信[TOC](目录如下&#xff1a;) 一、实验目的&#xff1a;二、实验环境三、实验内容四、实验步骤1、路由器的基本配置&#xff08;1&#xff09;实验拓扑图&#xff08;2&#xff…

文件系统.

终极目标&#xff1a; inode 和 软硬连接 文件系统 &#xff1a;Ext2 之前谈论的是一个被打开的文件&#xff01; 如果一个文件没有被打开呢&#xff1f;&#xff1f;磁盘中进行存储的。 我们会关心如下问题 1、路径问题 2、存储问题 3、获取的问题&#xff08;属性 文件内容…

java--封装

面向对象的三大特征&#xff1a;封装、继承、多态 1.什么是封装 就是用类设计对象处理某一个事物的数据时&#xff0c;应该把要处理的数据&#xff0c;以及处理这些数据的方法&#xff0c;设计到一个对象中去。(每一个类都可以看成封装) 2.封装的设计规范 合理隐藏、合理暴…

HarmonyOS NEXT 调优工具 Smart Perf Host 高效使用指南

在软件开发的过程中&#xff0c;很多开发者都经常会遇到一些性能问题&#xff0c;比如应用启动慢、点击滑动卡顿、应用后台被杀等&#xff0c;想要解决这些问题势必需要收集大量系统数据。而在收集数据的过程中&#xff0c;开发者则需要在各种工具和命令之间来回切换&#xff0…

Nginx实现tcp代理并支持TLS加密实验

Nginx源码编译 关于nginx的搭建配置具体参考笔者之前的一篇文章&#xff1a;实时流媒体服务器搭建试验&#xff08;nginxrtmp&#xff09;_如何在线测试流媒体rtmp搭建成功了吗-CSDN博客中的前半部分&#xff1b;唯一变化的是编译参数&#xff08;添加stream模块并添加其对应ss…

机组 指令系统

机器指令 机器指令&#xff1a;每一条机器语言的语句 指令系统&#xff1a;全部机器指令的集合 指令的一般格式 指令由操作码和地址码两部分组成 操作码 作用&#xff1a;指明该指令要完成的操作 位数&#xff1a;反映机器的操作种类&#xff0c;即机器允许的指令条数 …

redisTemplate不支持zpopmax,解决方案使用reverseRangeWithScore

在redis客户端可以使用zpopmax redisTemplate不支持zpopmax 解决方案 使用reverseRangeWithScore 接下来我们进行测试 我们要返回最大的value&#xff0c;应该是c import org.junit.Test; import org.junit.runner.RunWith; import org.springframework.beans.factory.a…

挑战100天 AI In LeetCode Day06(热题+面试经典150题)

挑战100天 AI In LeetCode Day06&#xff08;热题面试经典150题&#xff09; 一、LeetCode介绍二、LeetCode 热题 HOT 100-82.1 题目2.2 题解 三、面试经典 150 题-83.1 题目3.2 题解 一、LeetCode介绍 LeetCode是一个在线编程网站&#xff0c;提供各种算法和数据结构的题目&am…

Python爬虫实战-批量爬取美女图片网下载图片

大家好&#xff0c;我是python222小锋老师。 近日锋哥又卷了一波Python实战课程-批量爬取美女图片网下载图片&#xff0c;主要是巩固下Python爬虫基础 视频版教程&#xff1a; Python爬虫实战-批量爬取美女图片网下载图片 视频教程_哔哩哔哩_bilibiliPython爬虫实战-批量爬取…

本地数据库迁移到云端服务器

工具迁移xtrabackup 创建云服务器——通过云服务器提供的公网地址远程连接XShell——利用迁移工具将数据库从本地迁移到云服务器 &#xff08;1&#xff09;创建云服务器 &#xff08;2&#xff09;远程连接XShell &#xff08;3&#xff09;yum安装mysql &#xff08;4&…