搭建 Hugo & obsidian 工作流备忘

type

status

date

slug

summary

1.前置

1.1.安装 Hugo 框架

无论什么操作系统，按照官方教程即可

Installation

Install Hugo on macOS, Linux, Windows, BSD, and on any machine that can run the Go compiler tool chain.

。

1.2.安装 git 工具

不同操作系统按照官方教程即可

Git

Git is a free and open source distributed version control system designed to handle everything from small to very large projects with speed and efficiency.

。

不过在实践过程中，我使用git指令总是出现冲突报错，暂时解决后，在Linux系统和Windows系统之间交替使用，仍然出现一时无法解决的报错。所以索性全程使用Github Desktop，非常推荐不想深究git的普通用户。

1.2.安装 go 语言

按照官方教程，对应不同系统安装。

以下给出Linux系统的安装方式

下载 go 语言包 golangDownload and install - The Go Programming Language
Download and install - The Go Programming Language
Select the tab for your computer's operating system below, then follow its installation instructions.
golang

终端在下载包路径下执行命令

配置环境变量

文件末尾添加

使文件配置生效

安装成功，查看版本

2. 配置

在配置的最后，我们会得到到 obsidian 库的完整结构就是

工作流思路：

一天开始，使用Github Desktop同步昨天或者其他端的obsidian仓库

基于APS系统，使用obsidian管理和编辑markdown格式的本地文章

obsidian的templater插件功能可以快捷生成文章yaml属性
obsidian的linter插件可以自动更新标题，生成时间和更新时间
obsidian的dataview插件可以按条件查询所有笔记
obsidian的canvas插件可以有效组织和显示知识架构

挑选要发布的文章移动到myHugo文件夹的对应文件夹下

使用Commands插件生成hugo的public等文件

使用Github Desktop将myHugo下的public同步到userName.github.io仓库

一天结束，使用Github Desktop同步今天所有的obsidian仓库变化

需要注意的是，本地的myHugo文件夹因为属于obsidian仓库，所以将随 obsidian 库进行使用 Github Desktop 进行便捷备份，无需另外建立额外的仓库进行同步。所以一共会有两个github仓库

github的obsidian仓库对应本地的obsidian的vault文件夹

github的userName.github.io仓库对应本地的obsidian/myHugo/public文件夹

以下将配置Hugo框架github page，生成的静态网站也可以选择解析到个人域名。

2.1.通过 obsidian 打开

正常打开 obsidian 来到个人库，通过 obsidian 的 open vault in vscode 插件打开 vscode 终端。

2.2.初始网站

获得初始网站的文件结构，并进入到网站路径内/

2.3.配置主题

本站使用 hextra 主题

根目录下 hugo.yaml 修改为

2.4.内容结构

可以终端命令创建，也可以在obsidian中手动创建

文件结构对应顶部导航栏

修改 _index.md 基本属性如下

2.5.本地部署预览

终端指令

打开终端提供的地址 http://localhost:xxxxx/ 预览

2.5.更新

更新 hugo 框架

更新主题

3.部署到 github page

3.1.建立github page

在 github 中建立 github page，注意名称格式为 userName.github.io 。打开 page 功能。

我们无需使用很多教程推荐的 github actions，因为我们没有仓库更新之间的连锁动作。

再次注意，hugo网站的源文件（含所有的文章）将跟随 obsidian 库，使用 Github Desktop 每天进行备份。

💡

如果之前的仓库未解绑个人域名，直接删除仓库，可能导致域名提示被占用，需要重新验证域名的拥有权。

3.2.使用 Github Desktop 发布

在obsidian将要发布的文章移动到myHugo相应文件夹下，生成网站后，使用 Github Desktop 即可发布。

此时查看 github page 即可看到生成的网站。

4.使用 obsidian 快乐的更新和管理我们的 hugo 网站吧！

5.另外

5.1.文章加密

未有简单合适的方案

💡

欢迎您在底部评论区留言，一起交流~