Hugo/README.md

58 lines
2.8 KiB
Markdown
Raw Normal View History

2023-09-07 15:16:23 -04:00
<img align="right" width="150" alt="logo" src="https://user-images.githubusercontent.com/5889006/190859553-5b229b4f-c476-4cbd-928f-890f5265ca4c.png">
# Hugo Theme Stack Starter Template
2022-03-06 04:28:02 -05:00
2022-03-06 05:31:09 -05:00
This is a quick start template for [Hugo theme Stack](https://github.com/CaiJimmy/hugo-theme-stack). It uses [Hugo modules](https://gohugo.io/hugo-modules/) feature to load the theme.
2022-03-06 04:28:02 -05:00
It comes with a basic theme structure and configuration. GitHub action has been set up to deploy the theme to a public GitHub page automatically. Also, there's a cron job to update the theme automatically everyday.
2023-09-07 15:16:23 -04:00
## Get started
2022-03-06 04:28:02 -05:00
1. Click *Use this template*, and create your repository on GitHub.
![Step 1](https://user-images.githubusercontent.com/5889006/156916624-20b2a784-f3a9-4718-aa5f-ce2a436b241f.png)
2. Once the repository is created, create a GitHub codespace associated with it.
2022-03-06 04:28:02 -05:00
![Create codespace](https://user-images.githubusercontent.com/5889006/156916672-43b7b6e9-4ffb-4704-b4ba-d5ca40ffcae7.png)
3. And voila! You're ready to go. The codespace has been configured with the latest version of Hugo extended, just run `hugo server` in the terminal and see your new site in action.
4. Check `config` folder for the configuration files. You can edit them to suit your needs. Make sure to update the `baseurl` property in `config/_default/config.toml` to your site's URL.
5. Once you're done editing the site, just commit it and push it. GitHub action will deploy the site automatically to GitHub page associated with the repository.
2022-03-06 04:28:02 -05:00
![GitHub action](https://user-images.githubusercontent.com/5889006/156916881-90b8bb9b-1925-4e60-9d7a-8026cda729bf.png)
2023-09-07 15:16:23 -04:00
2022-03-06 04:28:02 -05:00
---
In case you don't want to use GitHub codespace, you can also run this template in your local machine. **You need to install Git, Go and Hugo extended locally.**
2022-03-06 04:28:02 -05:00
2023-09-07 15:16:23 -04:00
## Update theme manually
2022-03-06 04:28:02 -05:00
Run:
```bash
hugo mod get -u github.com/CaiJimmy/hugo-theme-stack/v3
hugo mod tidy
```
> This starter template has been configured with `v3` version of theme. Due to the limitation of Go module, once the `v4` or up version of theme is released, you need to update the theme manually. (Modifying `config/module.toml` file)
2023-09-07 15:16:23 -04:00
## Deploy to another static page hostings
2022-03-06 04:28:02 -05:00
If you want to build this site using another static page hosting, you need to make sure they have Go installed in the machine.
<details>
<summary>Vercel</summary>
You need to overwrite build command to install manually Go:
```
amazon-linux-extras install golang1.11 && hugo --gc --minify
2022-03-06 04:28:02 -05:00
```
![](https://user-images.githubusercontent.com/5889006/156917172-01e4d418-3469-4ffb-97e4-a905d28b8424.png)
Make sure also to specify Hugo version in the environment variable `HUGO_VERSION` (Use the latest version of Hugo extended):
![Environment variable](https://user-images.githubusercontent.com/5889006/156917212-afb7c70d-ab85-480f-8288-b15781a462c0.png)
2022-03-06 04:31:38 -05:00
</details>