Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/attajak/hugo-fixit-bundle
Hugo FixIt theme components (Gitmodule)
https://github.com/attajak/hugo-fixit-bundle
fixit fixit-bundle gitmodules hugo
Last synced: 6 days ago
JSON representation
Hugo FixIt theme components (Gitmodule)
- Host: GitHub
- URL: https://github.com/attajak/hugo-fixit-bundle
- Owner: attajak
- License: mit
- Created: 2025-01-26T08:25:15.000Z (19 days ago)
- Default Branch: main
- Last Pushed: 2025-02-06T17:23:38.000Z (8 days ago)
- Last Synced: 2025-02-06T18:32:55.918Z (8 days ago)
- Topics: fixit, fixit-bundle, gitmodules, hugo
- Language: TOML
- Homepage:
- Size: 44.9 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.cn.md
- License: LICENSE
Awesome Lists containing this project
README
# Hugo FixIt 博客模板（Git）
👉 中文 | [English](README.en.md)
这是 Hugo 主题 [FixIt](https://github.com/hugo-fixit/FixIt) 的快速启动模板。它使用 [Git 子模块](https://git-scm.com/book/en/v2/Git-Tools-Submodules) 功能来加载主题。如果你更熟悉 Go，可以 [查看这个模板](https://github.com/hugo-fixit/hugo-fixit-starter)。
它提供了基本的主题结构和配置。已经设置了 GitHub Actions，可以自动部署博客到 GitHub Pages。此外，还有一个定时任务，每天自动更新主题。
## 目录结构
```bash
▸ .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
```
## 快速入门
完整的快速入门请参阅此 [页面](https://fixit.lruihao.cn/documentation/getting-started/)。
### 准备
[Hugo](https://gohugo.io/installation/): >= 0.132.0 (extended version)
### 使用此模板
#### CLI
```bash
npx fixit-cli create my-blog
```
#### 手动
1. 点击 [**Use this template**](https://github.com/hugo-fixit/hugo-fixit-starter1/generate)，在 GitHub 上创建你的仓库。
2. 仓库创建后，只需克隆并开始使用！
```bash
# 使用你自己的仓库 URL 进行克隆
git clone --recursive https://github.com//.git
```
> [!TIP]
> 仓库名决定了你的 GitHub Pages URL，例如：
>
> | 仓库名 | GitHub Pages |
> | :--- | :--- |
> | `.github.io` | `https://.github.io/` |
> | `blog` | `https://.github.io/blog/` |
### 启动站点
```bash
# 开发环境
hugo server
# 生产环境
hugo server -e production
```
### 构建站点
当你的站点准备部署时，运行以下命令：
```bash
hugo
```
### 部署到 GitHub Pages
> [!NOTE]
> 聪明的你可能已经注意到，模板初始化后的第一次 GitHub Actions 自动部署失败了。这是因为你还没有配置 Workflow 权限和 GitHub Pages。
1. 转到 Setting => Actions => General => Workflow permissions => 选中 "Read and write permissions"。
2. GitHub Pages 设置：Setting => Pages => Source: GitHub Actions。
3. 修改 `config/_default/hugo.toml` 文件中的 `baseURL` 为你的站点 URL。
4. 提交上一步的修改到 `main` 分支，GitHub Actions 将自动打包并部署站点到 GitHub Pages。
### 更新主题
之后，你可以使用以下命令升级主题：
```bash
# 手动更新主题
git submodule update --remote --merge themes/FixIt
```
通过 NPM 脚本启动
```bash
npm install
# 构建博客
npm run build
# 运行带有监视的本地调试服务器
npm run server
# 在生产环境中运行本地调试服务器
npm run server:production
# 更新主题子模块
npm run update:theme
```
## 故障排除
remote: Permission to git denied to github-actions[bot].
转到 Setting => Actions => General => Workflow permissions => 选中 "Read and write permissions"。