hugo-fixit-starter
v1.0.0
Published
This is a quick start template for Hugo theme [FixIt](https://github.com/hugo-fixit/FixIt). It uses [Hugo submodule](https://gohugo.io/hugo-modules/) feature to load the theme.
Readme
Hugo FixIt 博客模板(Go)
👉 中文 | English
这是 Hugo 主题 FixIt 的快速启动模板。它使用 Hugo 模块 功能加载主题。如果你更熟悉 Git,可以 查看这个模板。
它提供了基本的主题结构和 配置目录^1。已经设置了 GitHub Actions,可以自动部署博客到 GitHub Pages。此外,还有一个定时任务,每天自动更新主题。
目录结构
▸ .github/ # GitHub configuration
▸ archetypes/ # page archetypes (like scaffolds of archetypes)
▸ assets/ # css, js, third-party libraries etc.
▸ config/ # configuration files
▸ content/ # markdown files for hugo project
▸ data/ # blog data (allow: yaml, json, toml), e.g. friends.yml
▸ public/ # build directory
▸ static/ # static files, e.g. favicon.ico
▸ themes/ # theme submodules
▸ go.mod
▸ go.sum快速入门
完整的快速入门,请参阅此 页面。
准备
使用模板
CLI
npx fixit-cli create my-blog手动
点击 Use this template,在 GitHub 上创建你的存储库。
存储库创建后,只需克隆并享受吧!
# 使用你自己的存储库 URL 进行克隆 git clone --recursive https://github.com/<your_name>/<your_blog_repo>.git
[!TIP] 仓库名决定了你的 GitHub Pages URL,例如:
| 仓库名 | GitHub Pages | | :--- | :--- | |
<your_name>.github.io|https://<your_name>.github.io/| |blog|https://<your_name>.github.io/blog/|
启动站点
# 开发环境
hugo server
# 生产环境
hugo server -e production构建站点
当你的站点准备部署时,运行以下命令:
hugo部署到 GitHub Pages
[!NOTE] 聪明的你可能已经注意到,模板初始化后的第一次 GitHub Actions 自动部署失败了。这是因为你还没有配置 Workflow 权限和 GitHub Pages。
- 转到 Setting => Actions => General => Workflow permissions => 选中 "Read and write permissions"。
- GitHub Pages 设置:Setting => Pages => Source: GitHub Actions。
- 修改
config/_default/hugo.toml文件中的baseURL为你的站点 URL。 - 提交上一步的修改到
main分支,GitHub Actions 将自动打包并部署站点到 GitHub Pages。
更新主题
之后,你可以使用以下命令升级主题:
# 手动更新主题
hugo mod get -u github.com/hugo-fixit/FixIt@latest
hugo mod tidy# 构建博客
npm run build
# 运行带有监视的本地调试服务器
npm run server
# 在生产环境中运行本地调试服务器
npm run server:production
# 更新主题子模块
npm run update:theme故障排除
部署(手动)
本博客采用手动部署到 GitHub Pages:
cd /Volumes/H520/coda/projects/blog-fixit
hugo # 生成 public/
# 把 public/ 内容同步到 loommii.github.io 仓库
# 例: cp -R public/* <loommii.github.io仓库路径>/ 然后在该仓库 git push