https://github.com/hugo-fixit/hugo-fixit-starter
đ A quick-start template base on Hugo Modules to create a Hugo FixIt site.
https://github.com/hugo-fixit/hugo-fixit-starter
blog hugo-blog hugo-blog-template hugo-fixit-starter hugo-theme-fixit
Last synced: 11 days ago
JSON representation
đ A quick-start template base on Hugo Modules to create a Hugo FixIt site.
- Host: GitHub
- URL: https://github.com/hugo-fixit/hugo-fixit-starter
- Owner: hugo-fixit
- License: mit
- Created: 2022-09-30T09:28:41.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-11-05T00:36:24.000Z (6 months ago)
- Last Synced: 2024-11-05T01:26:04.837Z (6 months ago)
- Topics: blog, hugo-blog, hugo-blog-template, hugo-fixit-starter, hugo-theme-fixit
- Language: JavaScript
- Homepage: https://hugo-fixit.github.io/hugo-fixit-starter/
- Size: 1.42 MB
- Stars: 31
- Watchers: 0
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.en.md
- License: LICENSE
Awesome Lists containing this project
README
# Hugo FixIt Blog Template (Go)
đ English | [įŽäŊä¸æ](README.md)
This is a quick start template for Hugo theme [FixIt](https://github.com/hugo-fixit/FixIt). It uses [Hugo Modules](https://gohugo.io/hugo-modules/) feature to load the theme. If you favor Git more, you can [check this template](https://github.com/hugo-fixit/hugo-fixit-starter1).
It comes with a basic theme structure and configuration. GitHub action has been set up to deploy the blog to a public GitHub page automatically. Also, there's a cron job to update the theme automatically everyday.
## Directory structure
```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
⸠go.mod
⸠go.sum
```
## Quick Start
For a complete quick start, see this [page](https://fixit.lruihao.cn/documentation/getting-started/).
### Prerequisites
- [Go](https://go.dev/dl/)
- [Hugo](https://gohugo.io/installation/) (extended version)
### Use Template
#### CLI
```bash
npx fixit-cli create my-blog
```
#### Manual
1. Click [**Use this template**](https://github.com/hugo-fixit/hugo-fixit-starter/generate), and create your repository on GitHub.
2. Once the repository is created, just clone and enjoy it!
```bash
# Clone with your own repository url
git clone --recursive https://github.com//.git
```
> [!TIP]
> The repository name determines your GitHub Pages URL, for example:
>
> | Repository Name | GitHub Pages |
> | :--- | :--- |
> | `.github.io` | `https://.github.io/` |
> | `blog` | `https://.github.io/blog/` |
### Launching the Site
```bash
# Development environment
hugo server
# Production environment
hugo server -e production
```
### Build the Site
When your site is ready to deploy, run the following command:
```bash
hugo
```
### Deploy to GitHub Pages
> [!NOTE]
> You may have noticed that the first automatic deployment of GitHub Actions after the template initialization failed. This is because you have not configured Workflow permissions and GitHub Pages.
1. Head to Setting => Actions => General => Workflow permissions => Check "Read and write permissions".
2. GitHub Pages settings: Setting => Pages => Source: GitHub Actions.
3. Modify `config/_default/hugo.toml` file `baseURL` to your site URL.
4. Commit the changes from the previous step to the `main` branch, and GitHub Actions will automatically build and deploy the site to GitHub Pages.
### Update Theme
Afterwards you can upgrade the theme with the following command:
```bash
# Update theme manually
hugo mod get -u github.com/hugo-fixit/FixIt@latest
hugo mod tidy
```
Start via NPM script
```bash
# build the blog
npm run build
# run a local debugging server with watch
npm run server
# run a local debugging server in production environment
npm run server:production
# update theme submodules
npm run update:theme
```
## Troubleshooting
remote: Permission to git denied to github-actions[bot].
Head to Setting => Actions => General => Workflow permissions => Check "Read and write permissions".