Hugo 建站经验之谈

2020-06-23 10:18:01 +08:00
 NebulaGraph

前言

建站工具,早已不是一个新颖的话题,抛开可视化建站单论开发层面,各类语言都有推出广受欢迎的建站框架,比如 Python 开发的 Pelican,JavaScript 开发的 Hexo,以及市场份额占比最大的 PHP 开发的 WordPress 等等,这些笔者在折腾个人博客时多少都有用过。但当需要快速搭建起我们的 Nebula Graph 官网 时,小小纠结对比之后,笔者选择了 Golang 语言的 Hugo 来作为我们的技术方案,下面就来分享下个人使用 Hugo 建站的一些个人思考和经验分享。

P.S: 客观来说,各类语言的博客类型框架并无太大差别,更多还是类比语言的个人喜好与审美不同,在此不做叙述。

实践介绍

我们的需求

Hugo 有灵活强大的内容管理系统,能随着需求,不断增加不同类型的资讯支持,诸如博客、Release Note 、技术文档等,详细后面会介绍。

同样依赖内容管理系统,能很快支持到不同页面的实现,包括相同组件如导航、页脚等的共享,后面也会介绍。

Hugo 本就是类似服务端模板语言的 Web 框架,天然的服务端渲染。

Hugo 能渐进地拓展支持多国语言,只要你有对应的语料配置,就能迅速支撑需求并方便管理。

强大的模板系统,让技术人员专心开发完对应模板后,能将内容管理交给运营同学持续运营。

特点介绍

灵活强大的内容管理系统

...
├── config // 模板需要的内容语料
|   ├── default 
|   |   ├── config.toml
|   |   └── config.cn.toml
|   |   └── config.en.toml
|   |   └── footer.cn.toml
|   |   └── footer.en.toml
|   |   └── ...
├── content // 内容部分,日常多由运营同学管理维护
|   ├── en // 国际化支持
|   |   ├── posts // 内置默认的博客( post)类型资讯
|   |   |   ├── post-01.md
|   |   |   ├── post-02.md
|   |   └── release // 新增的 release 类型资讯
|   |   |   ├── release-01.md
|   |   |   └── release-02.md
|   ├── cn
|   |   ├── posts
|   |   |   ├── post-01.md
|   |   |   ├── post-02.md
|   |   └── release
|   |   |   ├── release-01.md
|   |   |   └── release-02.md
...
├── themes // 站点的主题
|   ├── nebula-theme // 主题名
|   |   ├── layout // 模板
|   |   |   ├── _default // 默认的模板
|   |   |   |   ├── baseof.html // 渲染的种子页面定义
|   |   |   |   ├── list.html  // 默认博客 post 类型资讯 - 列表页的使用模板页面
|   |   |   |   ├── single.html // 默认博客 post 类型资讯 - 详情页使用模板页面
|   |   |   ├── partials // 复用的模板片段
|   |   |   |   ├── head.html
|   |   |   |   ├── footer.html
|   |   |   |   ├── menus.html
|   |   |   |   ├── ...
|   |   |   ├── index.html // 首页('/') 默认会使用的模板
|   |   |   ├── section
|   |   |   |   ├── release.html // 新增资讯类型 release 渲染时使用的模板页面 - 发布历史页面
|   |   |   |   ├── news.html // 新增资讯类型 news 渲染时使用的模板页面 - 媒体新闻页面
...

以上,便是 Hugo 用以支撑起灵活强大的模板系统所采用的项目结构,笔者感觉比较能直观反映出对于不同站点需求的支持,它甚至还可以是不断嵌以此结构不断嵌套,外层的配置覆盖内层的,更多信息可以参考官方的模板系统介绍

内置丰富工具集

除了强大的内容管理系统外,Hugo 还有很多很好用的内置模板及工具函数,满足不同需求情况下提升搭建效率,抽象实现细节,更专注于站点的搭建,诸如:

这个针对只有列表页的需求,比如博客,发版历史,新闻类等,好用的分页模板,轻松的就帮你完成了。

对于资讯型的站点必不可少,官方已内置了默认的 rss 模板,只需要添加一行代码,即可搞定 rss,当然还支持个性化定制。

这个不用多说,对应程序中的各类常见的字符串替换,Hugo 都有着良好的支持,同时它还支持类似 Pipe 管道的方式,将处理内容以 | 分隔层层传递下去,就像我们在 Linux 输入的命令一样。

内置了 http server 方便本地开发,同时又能将整个站点打包成纯静态的资源,方便了对于部署的操作和维护成本,可以一键初始化并启动项目,开箱即用的感觉,上手容易。

以上便是我们在实践中,有接触过的一些 Hugo 比较好用的工具,当然它提供的远比这个更丰富,更多工具可查看参考官方文档

社区资源丰富

作为 Golang 语言最受欢迎的站点框架,随着越来越多人的使用,Hugo 官方鼓励大家开源自己的主题,约定了简易可行的规范,让贡献者的主题能在 Hugo 官网方便地被他人找到,易于复用。非技术的同学,也可以找到符合自己需求的主题,不用写一行 HTML 代码,也能让自己生成自己的站点。

经验总结

除了上面偏向于 Hugo 本身提供的功能介绍外,下面结合笔者自身的实践经历,阐述一些小小的经验总结,方便后来的朋友:

使用现成的主题

基于 DIY 原则来说,结合自身需求,去主题市场找一个符合自己的主题来进行修改,应该是上手最快的方式了,甚至不需要开发就能拿来直接用,即使需要开发,使用他人已开发好的主题,由于 Hugo 框架本身具有很好的约定规范,你也能很快了解到一个 Hugo 项目的结构组成及运行机制,降低调研上手成本。

项目结构和内容关系

就像前面介绍的内容管理系统,从结构上了解内容 contents 与模板 layouts 之间的映射关系,适当结合官网文档的介绍,了解这层映射关系后,能方便在后续的开发过程中,让你的实践更符合 Hugo 期望的形式来进行,这样会让你不论是实现,还是在阅读 Hugo 文档的时候,事半功倍,易于理解。

个人定制

除了 Hugo 本身的框架、规范及工具能力外,因为网页的代码最终还是离不开 HTML/CSS/Javascript,自定义相关的内容,只要善用提供的规则(如各个模板的引用,组合),就能在各个模板入口引入你想自己控制的代码部分,为你自己的站点添砖加瓦。结合我们自身的实践,比如第三方站点插件的集成(埋点统计,Discourse 、ShareThis 等等),一些自定义弹窗等动态 js 的添加,所以只要熟悉网页的常规开发,除了 Hugo 的能力外,你可以做到你以往可做的任何事情。

纯静态站点

Hugo 打包构建后输出的是一个纯静态的资源包,这样地好处就是你可以将你的站点部署在任何地方,比如使用 GitHub 免费的 Pages,又或者是随便放在 oss 源中,没有维护服务器,数据库的烦恼。纯静态资源部署很便捷,以 Hugo 为例,他的路由适合文件目录相关的,我们的站点有中英文两个语言版本,开发时都放在一个项目中进行维护共享模板,在构建部署时,会根据语言打成不同的资源包,分别发到不同的国内外 Web 容器,以此优化访问体验。

最后

以上便是笔者使用 Hugo 框架搭建公司 Nebula Graph 官网 的一些实践心得,希望给有快速建站需求的朋友提供一些思路和参考,我们的站点是基于已有主题二次开发,更多细节感兴趣的朋友也可以看看我们放在 GitHub 的源站仓库

也欢迎大家来了解我们的 Nebula Graph 图数据库产品 或者前往官方论坛:https://discuss.nebula-graph.com.cn/建议反馈 分类下提建议 👏;加入 Nebula Graph 交流群,请联系 Nebula Graph 官方小助手微信号:NebulaGraphbot

作者有话说:Hi,我是 Jerry,是图数据 Nebula Graph 前端工程师,在前端平台工具开发及工程化方面有些小心得,希望写的经验分享能给大家带来帮助,如有不当之处也希望能帮忙纠正,谢谢~

4467 次点击
所在节点    推广
13 条回复
feiyang221
2020-06-23 10:26:48 +08:00
收藏
JB18CM
2020-06-23 10:33:22 +08:00
支持
saltbo
2020-06-23 10:50:05 +08:00
我从 hugo 换成 vuepress 了,因为 hugo 的模板开发我觉得不方便。不过确实对于没用过 vue 的来说 hugo 的模板开发反而更简单。赞一个。

另自荐下专门为静态网站开发的部署工具 https://github.com/saltbo/uptoc,利用这个工具可以很方便的将静态网站部署到任何云存储平台。
saltbo
2020-06-23 10:51:07 +08:00
v2ex 文中发链接真不友好,重发下。。

https://github.com/saltbo/uptoc
Kakarrot
2020-06-23 11:19:31 +08:00
感觉还是 Hexo 更简单一些 不用考虑什么模板问题
dimlau
2020-06-23 12:10:36 +08:00
前几天刚把博客程序换成了 HUGO

https://kaix.in/0001/hugo/

静态果然还是不方便。
jasamboro
2020-06-23 12:56:02 +08:00
@dimlau 还是动态程序生成静态页面比较爽
maoxs2
2020-06-23 13:12:30 +08:00
我基本上所有 index 和 doc 都是靠 hugo 的。个人感觉 Hugo 唯一的蛋疼点就在于现在前端又现代化又成熟的 ui 都是 npm toolchain 形式了,拿来写模板真的很别扭…
saltbo
2020-06-23 14:28:13 +08:00
@maoxs2 所以可以换 Vuepress 。
maoxs2
2020-06-23 16:43:20 +08:00
@saltbo vuepress 安装时候有一步是那个去 github 下 release 每次都搞我心态……还有 gastby 也是。还是 hugo 这样的 binary 比较好用…直接 choco install hugo --proxy xxx 。
saltbo
2020-06-23 17:03:03 +08:00
yang2048
2020-06-23 17:35:12 +08:00
还没找到满意的主题,插件库还不是很强大
maoxs2
2020-06-23 19:12:54 +08:00
@saltbo 挠挠头,上次看的时候还是全局安装来着…多谢安利我再试试!

这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://www.v2ex.com/t/684001

V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX