Skip to content

Commit f6b16eb

Browse files
xieyuenxieyuen
committed
docs(site): 更新网站文档结构
- 移除原始的Hugo主题模板说明文档 - 添加河中数协官方网站的简介和链接 - 创建help目录并添加Hugo主题栈模板文档 - 新建theme_copyright_info目录存储主题版权信息 - 在主页添加主题版权信息链接
1 parent d75e366 commit f6b16eb

4 files changed

Lines changed: 56 additions & 45 deletions

File tree

‎README.md‎

Lines changed: 3 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,5 @@
1-
<img align="right" width="150" alt="logo" src="https://user-images.githubusercontent.com/5889006/190859553-5b229b4f-c476-4cbd-928f-890f5265ca4c.png">
1+
# 河中数协官方网站
22

3-
# Hugo Theme Stack Starter Template
3+
website: https://hzmath.github.io
44

5-
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.
6-
7-
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.
8-
9-
## Video Tutorial
10-
11-
In case you got lost during the setup process, here's a video tutorial that setups a new Hugo site using this template, and deploys it to GitHub Pages: https://www.youtube.com/watch?v=8qDdQQ6Ifxo
12-
13-
## Get started
14-
15-
1. Click *Use this template*, and create your repository as `<username>.github.io` on GitHub. (You can also use a different repository name, but then the resulting website will be available at `https://<username>.github.io/<repository-name>`. )
16-
![Step 1](https://user-images.githubusercontent.com/5889006/156916624-20b2a784-f3a9-4718-aa5f-ce2a436b241f.png)
17-
18-
2. Once the repository is created, create a GitHub codespace associated with it.
19-
![Create codespace](https://user-images.githubusercontent.com/5889006/156916672-43b7b6e9-4ffb-4704-b4ba-d5ca40ffcae7.png)
20-
21-
3. While waiting for the codespace to be created, go to `Settings` -> `Pages` of your newly created repository, and set `Build and deployment` -> `Source` to `GitHub Actions`.
22-
![Change build and deployment source](https://github.com/user-attachments/assets/192459bf-25d8-441e-8029-c108d789e449)
23-
24-
4. After the codespace is created, you can test that the site is built successfully by running `hugo server` in the terminal and see your new site in action.
25-
26-
5. 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. For example, if your new repository is named `my-blog`, then the `baseurl` should be `https://<username>.github.io/my-blog/`.
27-
28-
6. 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.
29-
30-
---
31-
32-
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.** For more information, check official Hugo documentation: https://gohugo.io/installation/
33-
34-
## Update theme manually
35-
36-
Run:
37-
38-
```bash
39-
hugo mod get -u github.com/CaiJimmy/hugo-theme-stack/v4
40-
hugo mod tidy
41-
```
42-
43-
> This starter template has been configured with `v4` 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)
44-
45-
## Deploy to another static page hostings
46-
47-
Check official Hugo documentation: https://gohugo.io/host-and-deploy/
5+
theme copyright info: [Info](./theme_copyright_info/README.md)

‎help/README.md‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
<img align="right" width="150" alt="logo" src="https://user-images.githubusercontent.com/5889006/190859553-5b229b4f-c476-4cbd-928f-890f5265ca4c.png">
2+
3+
# Hugo Theme Stack Starter Template
4+
5+
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.
6+
7+
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.
8+
9+
## Video Tutorial
10+
11+
In case you got lost during the setup process, here's a video tutorial that setups a new Hugo site using this template, and deploys it to GitHub Pages: https://www.youtube.com/watch?v=8qDdQQ6Ifxo
12+
13+
## Get started
14+
15+
1. Click *Use this template*, and create your repository as `<username>.github.io` on GitHub. (You can also use a different repository name, but then the resulting website will be available at `https://<username>.github.io/<repository-name>`. )
16+
![Step 1](https://user-images.githubusercontent.com/5889006/156916624-20b2a784-f3a9-4718-aa5f-ce2a436b241f.png)
17+
18+
2. Once the repository is created, create a GitHub codespace associated with it.
19+
![Create codespace](https://user-images.githubusercontent.com/5889006/156916672-43b7b6e9-4ffb-4704-b4ba-d5ca40ffcae7.png)
20+
21+
3. While waiting for the codespace to be created, go to `Settings` -> `Pages` of your newly created repository, and set `Build and deployment` -> `Source` to `GitHub Actions`.
22+
![Change build and deployment source](https://github.com/user-attachments/assets/192459bf-25d8-441e-8029-c108d789e449)
23+
24+
4. After the codespace is created, you can test that the site is built successfully by running `hugo server` in the terminal and see your new site in action.
25+
26+
5. 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. For example, if your new repository is named `my-blog`, then the `baseurl` should be `https://<username>.github.io/my-blog/`.
27+
28+
6. 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.
29+
30+
---
31+
32+
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.** For more information, check official Hugo documentation: https://gohugo.io/installation/
33+
34+
## Update theme manually
35+
36+
Run:
37+
38+
```bash
39+
hugo mod get -u github.com/CaiJimmy/hugo-theme-stack/v4
40+
hugo mod tidy
41+
```
42+
43+
> This starter template has been configured with `v4` 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)
44+
45+
## Deploy to another static page hostings
46+
47+
Check official Hugo documentation: https://gohugo.io/host-and-deploy/

LICENSE renamed to theme_copyright_info/LICENSE

File renamed without changes.

‎theme_copyright_info/README.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Copyright of website theme
2+
3+
Here stores the copyright info and license of the theme
4+
that this website is using.
5+
6+
Theme [Stack](https://github.com/CaiJimmy/hugo-theme-stack) is designed by [Jimmy](https://jimmycai.com/).

0 commit comments

Comments
 (0)