doc: add logo to README.md
This commit is contained in:
parent
9fc078dff0
commit
af661a4648
11
README.md
11
README.md
@ -1,10 +1,12 @@
|
|||||||
## Hugo Theme Stack Starter Template
|
<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
|
||||||
|
|
||||||
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.
|
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.
|
||||||
|
|
||||||
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.
|
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.
|
||||||
|
|
||||||
To get started:
|
## Get started
|
||||||
|
|
||||||
1. Click *Use this template*, and create your repository on GitHub.
|
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)
|
![Step 1](https://user-images.githubusercontent.com/5889006/156916624-20b2a784-f3a9-4718-aa5f-ce2a436b241f.png)
|
||||||
@ -18,11 +20,12 @@ To get started:
|
|||||||
|
|
||||||
5. Once you're done editing the site, just commit it and push it. GitHub action will deploy the site automatically to GitHub page asociated with the repository.
|
5. Once you're done editing the site, just commit it and push it. GitHub action will deploy the site automatically to GitHub page asociated with the repository.
|
||||||
![GitHub action](https://user-images.githubusercontent.com/5889006/156916881-90b8bb9b-1925-4e60-9d7a-8026cda729bf.png)
|
![GitHub action](https://user-images.githubusercontent.com/5889006/156916881-90b8bb9b-1925-4e60-9d7a-8026cda729bf.png)
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
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.**
|
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.**
|
||||||
|
|
||||||
### Update theme manually
|
## Update theme manually
|
||||||
|
|
||||||
Run:
|
Run:
|
||||||
|
|
||||||
@ -33,7 +36,7 @@ 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)
|
> 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)
|
||||||
|
|
||||||
### Deploy to another static page hostings
|
## Deploy to another static page hostings
|
||||||
|
|
||||||
If you want to build this site using another static page hosting, you need to make sure they have Go installed in the machine.
|
If you want to build this site using another static page hosting, you need to make sure they have Go installed in the machine.
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user