使用 Hugo 与 GitHub Pages 快速建站

前言

作为一名程序员,并且是一名有追求的程序员,技术影响力 对我们不可或缺。今天介绍一下我是如何利用 Hugo 与 GitHub Pages 快速搭建个人内容输出平台。

Hugo 与 GitHub Pages 简介

Hugo: 世界上最快的网站建设框架,将 Markdown 文件生成 HTML 静态页面。

GitHub Pages GitHub 提供的静态网页托管服务,不需要额外的服务器来部署你的博客系统了。

搭建过程

  1. 安装 Hugo

Mac 直接使用以下命令二进制安装

brew install hugo
  1. GitHub 创建一个仓库,如 xiaohe-blog,并且 git clone 到本地

  2. 使用 Hugo 初始化 Clone 下来的仓库

hugo new site xiaohe-blog --force

生成文件目录应该如下:

├── archetypes  // 文章默认模版
│   └── default.md
├── config.toml // 配置文件
├── content     // Markdown 文件
├── data        // 
├── layouts     // html 文件
├── static      // 图片, CSS, JS...
└── themes      // hugo 主题
  1. 选择一款主题

这里为了快速搭建,使用默认主题,后期根据个人需要去修改主题

git submodule add https://github.com/theNewDynamic/gohugo-theme-ananke.git themes/ananke

echo theme = \"ananke\" >> config.toml
  1. 发布一篇博客
hugo new posts/my-first-post.md

你也可以之间在 /contents 文件夹下直接新建一个 markdown 文件

  1. 本地启动测试
hugo server -D

打开命令行给出的地址,修改 markdown 文件,网页还会实时变化

  1. GitHub Pages 设置(这里只介绍其中最简单的一种方式)

Github 仓库首页 -> Settings -> Pages -> main -> docs -> save

会出现一个网站地址: user-name.github.io/repo-name/

意思是打开这个地址就会展现仓库 /docs 下的内容。

接下来我们的工作就是:把 Hugo 生成的静态网页生成文件放在 /docs 文件夹下,再 push 到 GitHub。

  1. 修改 config.toml
    示例如下,请自行修改
baseURL = 'https://he2121.github.io/xiaohe-blog/'   // 设置成你自己的
languageCode = 'zh-cn'
title = '小贺的博客'
theme = "ananke"
publishDir = 'docs'
  1. 生成静态网页,push 到 GitHub
hugo -D // 生成静态网页
git add .
git commit -m "first commit"
git push

打开 GitHub 提供的页面链接 https://he2121.github.io/xiaohe-blog/
测试是否成功

个性化

建议先跳去看总结

使用

平时使用 idea/vscode 在本地编辑 markdown,实时本地看网页效果,编辑完生成静态网页,push 到远程即输出一篇文章

主题

挑选了这款主题 https://themes.gohugo.io/themes/hugo-theme-cactus-plus/

按照教程安装即可。

评论功能要去 https://disqus.com/ 申请账号。
网页统计数据 https://analytics.google.com/analytics/web/ 注册。

给出个人配置文件

baseURL = 'https://he2121.github.io/xiaohe-blog/'
languageCode = 'zh-cn'
defaultContentLanguage = 'cn'
title = '小贺的博客'
publishDir = 'docs'
theme = 'github.com/nodejh/hugo-theme-mini'

googleAnalytics = 'G-583xxxxxx'
disqusShortname = 'xxxx'

[social]
github = "https://github.com/he2121/"

[params]
author = '小贺'
bio = 'Golang 工程师'
description = "小贺的博客"
enableGoogleAnalytics = true
enableComments = true
[[params.links]]
name = "tag"
path = "/xiaohe-blog/tags"
[[params.links]]
name = "算法"
path = "/xiaohe-blog/算法"
[[params.links]]
name = "建站"
path = "/xiaohe-blog/建站"
[[params.links]]
name = "杂谈"
path = "/xiaohe-blog/杂谈"

总结

使用 Hugo 与 GitHub Pages 能够很快搭建一个个人网站,但是定制化比较花费时间,
建议新手全部使用默认功能即可,写文章才是重点,其他应该暂时忽略。

上一篇:Hugo 博客搭建,部署Github Pages


下一篇:Hugo+github博客第一次上传到github及提交更新