开发工具分享
  • 首页
  • 计算科学
  • 文化旅游
  • 项目和网站
    • OSSEZ 计算技术
    • USRealEstate 社区
    • 地区文化
    • CWIKI.US
    • BUG.OSSEZ.COM
    • RSS.OSSEZ.COM
CWIKIUS.CN
一个有独立思考和温度的清新站
  1. Home
  2. Computer Science
  3. This article

Docsify 和 Hugo 之间的选型

2023年11月09日 470Browse 0Like 0Comments

对文档的编译,目前的发布方案是越来越注重 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 能够提供更多的复杂功能,但是又不会过多增加技术难度。

 

https://www.isharkfly.com/t/docsify-hugo/15115

Tags: None
Last updated:2023年11月09日

HoneyMoose

有温度的人文和独立的思考

Like
< Previous
Next >

Comments

Cancel reply

Archives
  • May 2026
  • April 2026
  • March 2026
  • February 2026
  • January 2026
  • December 2025
  • November 2025
  • October 2025
  • September 2025
  • August 2025
  • July 2025
  • June 2025
  • May 2025
  • April 2025
  • March 2025
  • February 2025
  • January 2025
  • December 2024
  • November 2024
  • October 2024
  • September 2024
  • August 2024
  • July 2024
  • June 2024
  • May 2024
  • April 2024
  • March 2024
  • February 2024
  • January 2024
  • December 2023
  • November 2023
  • October 2023
  • September 2023
  • August 2023
  • July 2023
  • June 2023
  • May 2023
  • April 2023
  • December 2022
  • November 2022
  • October 2022
  • September 2022
  • August 2022
  • May 2022
  • April 2022
  • March 2022
  • February 2022
  • January 2022
  • December 2021
  • November 2021
  • October 2021
  • September 2021
  • August 2021
  • July 2021
  • June 2021
  • May 2021
  • April 2021
  • March 2021
  • February 2021
  • January 2021
  • December 2020
  • November 2020
  • October 2020
  • September 2020
  • August 2020
  • July 2020
  • June 2020
  • May 2020
  • April 2020
  • March 2020
  • February 2020
  • January 2020
  • December 2019
  • November 2019
  • October 2019
  • September 2019
  • August 2019
  • July 2019
  • June 2019
  • May 2019
  • April 2019
  • March 2019
  • February 2019
  • January 2019
  • December 2018
  • November 2018
  • October 2018
  • September 2018
  • August 2018
  • July 2018
  • June 2018
  • May 2018
  • April 2018
  • March 2018
Categories
  • Computer Science (2,362)
    • Confluence (663)
    • Gradle (12)
  • U.S. (482)
  • 文化旅游 (145)

COPYRIGHT © 2020 CWIKIUS. ALL RIGHTS RESERVED.

THEME KRATOS MADE BY VTROIS

湘ICP备2020018253号-1