Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/geekswg/blog-fixit-go
blog-fixit-go
https://github.com/geekswg/blog-fixit-go
Last synced: 1 day ago
JSON representation
blog-fixit-go
- Host: GitHub
- URL: https://github.com/geekswg/blog-fixit-go
- Owner: geekswg
- Created: 2024-01-26T09:38:44.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-13T00:55:32.000Z (10 months ago)
- Last Synced: 2024-04-14T00:37:36.580Z (10 months ago)
- Language: JavaScript
- Homepage: http://geekswg.js.cool/blog-fixit-go/
- Size: 4.55 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.en.md
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.
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/): >= 0.112.0 (extended version)
### Use Template
1. Click **Use this template**, 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
```
### 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
```
### 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".