Skip to content

Commit 5c87216

Browse files
committed
docs: add hugo eureka starters
1 parent 813240c commit 5c87216

File tree

6 files changed

+76
-26
lines changed

6 files changed

+76
-26
lines changed

en/CHANGELOG.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,20 @@ draft: false
1313
weight: 7
1414
---
1515

16+
## 0.8.1 (2021-07-06)
17+
18+
19+
### Bug Fixes
20+
21+
* cannot switch color scheme without utterances ([ccd5695](https://github.com/wangchucheng/hugo-eureka/commit/ccd5695125f1516db25424dc723eaa9fc6b3e87a))
22+
* incorrect escape character display in summary ([378aad4](https://github.com/wangchucheng/hugo-eureka/commit/378aad4d6f541e6a0b2f9f79cd54315b310f3f72)), closes [#123](https://github.com/wangchucheng/hugo-eureka/issues/123)
23+
24+
25+
### Features
26+
27+
* add Korean i18n support ([#103](https://github.com/wangchucheng/hugo-eureka/issues/103)) ([11ee4a8](https://github.com/wangchucheng/hugo-eureka/commit/11ee4a8b146722582f2dd8600812463f76dd0a21))
28+
29+
1630
## 0.8.0 (2021-04-21)
1731

1832

en/getting-started.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,16 +23,27 @@ To use Eureka normally, you need to install the following:
2323

2424
- [Git](https://git-scm.com/)
2525
- [Hugo v0.74.0+](https://gohugo.io/getting-started/installing/)
26+
- [Go 1.12+](https://golang.org/dl/) (When installing with Hugo Modules)
2627

27-
## Installation
28+
## Quick Installation
2829

29-
Eureka can be quickly integrated into the Hugo project. Currently, Eureka can be installed in two ways: [Git Submodule](#install-with-git-submodule) and [Hugo Modules](#install-with-hugo-modules).
30+
Eureka can be quickly installed by using the Github Template [Hugo Eureka Starters](https://github.com/wangchucheng/hugo-eureka-starters).
3031

31-
### Install with Git Submodule
32+
When using this method, please click the `Use this template` button on the page and set your repository information.
33+
34+
If you want to install with Hugo Modules, just click the `Create repository from template` button after entering the information.
35+
36+
If you want to install with Git Submodules, please check the `Include all branches` option after entering the information, and then click the `Create repository from template` button. After the repository is created, set the default branch to the `git-submodules` branch.
37+
38+
## Manual Installation
39+
40+
Eureka can be quickly integrated into the Hugo project. Currently, Eureka can be installed in two ways: [Git Submodules](#install-with-git-submodules) and [Hugo Modules](#install-with-hugo-modules).
41+
42+
### Install with Git Submodules
3243

3344
> If you have or are willing to install [Go 1.12](https://golang.org/dl/) or above in the current environment, you can use the more convenient and quick [Hugo Modules](#install-with-hugo-modules) installation.
3445
35-
When installing with Git Submodule, you only need to execute under the project location:
46+
When installing with Git Submodules, you only need to execute under the project location:
3647

3748
```shell
3849
git submodule add https://github.com/wangchucheng/hugo-eureka.git themes/eureka

en/update.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,13 @@ Update Eureka will introduce different ways to update Eureka.
1919

2020
<!--more-->
2121

22-
Currently we can install Eureka in two ways: `Git Submodule` and `Hugo Modules`. Next you will learn how to update Eureka. It should be noted that you can only update in the same way as the installation.
22+
Currently we can install Eureka in two ways: `Git Submodules` and `Hugo Modules`. Next you will learn how to update Eureka. It should be noted that you can only update in the same way as the installation.
2323

24-
## Update with Git Submodule
24+
## Update with Git Submodules
2525

26-
> If you have or are willing to install [Go 1.12](https://golang.org/dl/) and above in the current environment, you can [migrate to Hugo Modules](#migrate-from-git-submodule-to-hugo-modules).
26+
> If you have or are willing to install [Go 1.12](https://golang.org/dl/) and above in the current environment, you can [migrate to Hugo Modules](#migrate-from-git-submodules-to-hugo-modules).
2727
28-
Use Git Submodule to update only in the project root directory:
28+
Use Git Submodules to update only in the project root directory:
2929

3030
```shell
3131
cd themes/eureka
@@ -53,17 +53,17 @@ hugo mod get github.com/wangchucheng/hugo-eureka@<eureka_version>
5353

5454
You can view the historical version of Eureka in [Releases](https://github.com/wangchucheng/hugo-eureka/releases).
5555

56-
## Migrate from Git Submodule to Hugo Modules
56+
## Migrate from Git Submodules to Hugo Modules
5757

58-
Because Hugo Modules is more convenient and faster to manage than Git Submodule, and Hugo Modules is Hugo's recommended way to add themes. It is recommended that all users who have or are willing to install [Go 1.12](https://golang.org/dl/) and above in the current environment migrate to Hugo Modules.
58+
Because Hugo Modules is more convenient and faster to manage than Git Submodules, and Hugo Modules is Hugo's recommended way to add themes. It is recommended that all users who have or are willing to install [Go 1.12](https://golang.org/dl/) and above in the current environment migrate to Hugo Modules.
5959

6060
### Install Go
6161

6262
To use most of the functions of Hugo Modules, you need to have Go 1.12 and above. You can install it on [Go official website](https://golang.org/dl/).
6363

64-
### Delete Git Submodule
64+
### Delete Git Submodules
6565

66-
To delete Git Submodule you only need to:
66+
To delete Git Submodules you only need to:
6767

6868
```shell
6969
git submodule deinit -f -- themes/eureka
@@ -83,7 +83,7 @@ hugo mod init <module_name>
8383

8484
Finally, comment `theme: eureka` in `config/_default/config.yaml` and uncomment `theme: github.com/wangchucheng/hugo-eureka`.
8585

86-
At this point you have completed the migration from Git Submodule to Hugo Modules.
86+
At this point you have completed the migration from Git Submodules to Hugo Modules.
8787

8888
---
8989

zh/CHANGELOG.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,20 @@ draft: false
1313
weight: 7
1414
---
1515

16+
## 0.8.1 (2021-07-06)
17+
18+
19+
### Bug Fixes
20+
21+
* cannot switch color scheme without utterances ([ccd5695](https://github.com/wangchucheng/hugo-eureka/commit/ccd5695125f1516db25424dc723eaa9fc6b3e87a))
22+
* incorrect escape character display in summary ([378aad4](https://github.com/wangchucheng/hugo-eureka/commit/378aad4d6f541e6a0b2f9f79cd54315b310f3f72)), closes [#123](https://github.com/wangchucheng/hugo-eureka/issues/123)
23+
24+
25+
### Features
26+
27+
* add Korean i18n support ([#103](https://github.com/wangchucheng/hugo-eureka/issues/103)) ([11ee4a8](https://github.com/wangchucheng/hugo-eureka/commit/11ee4a8b146722582f2dd8600812463f76dd0a21))
28+
29+
1630
## 0.8.0 (2021-04-21)
1731

1832

zh/getting-started.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,18 +25,29 @@ weight: 1
2525

2626
- [Git](https://git-scm.com/)
2727
- [Hugo v0.74.0+](https://gohugo.io/getting-started/installing/)
28+
- [Go 1.12+](https://golang.org/dl/) (使用Hugo Modules安装时)
2829

29-
## 安装
30+
## 快速安装
3031

31-
Eureka可以快速集成于Hugo项目中,目前Eureka可以通过[Git Submodule](#使用git-submodule安装)[Hugo Modules](#使用hugo-modules安装)两种方式进行安装。
32+
Eureka可以通过使用Github模板[Hugo Eureka Starters](https://github.com/wangchucheng/hugo-eureka-starters)快速安装。
33+
34+
使用此种方式时请点击页面上的`Use this template`按钮,并设置你的仓库信息。
35+
36+
如果你希望使用Hugo Modules的方式进行安装,在输入信息后直接点击`Create repository from template`按钮即可。
37+
38+
如果你希望使用Git Submodules的方式进行安装,在输入信息后请勾选`Include all branches`选项,再点击`Create repository from template`按钮。在仓库创建后,设置默认分支为`git-submodules`分支即可。
39+
40+
## 手动安装
41+
42+
Eureka可以快速集成于Hugo项目中,目前Eureka可以通过[Git Submodules](#使用git-submodules安装)[Hugo Modules](#使用hugo-modules安装)两种方式进行安装。
3243

3344
[Hugo Modules](#使用hugo-modules安装)需要[Go 1.12](https://golang.org/dl/)及以上版本,推荐所有拥有或愿意安装Go的用户使用此方式进行安装。
3445

35-
### 使用Git Submodule安装
46+
### 使用Git Submodules安装
3647

3748
> 如果当前环境下拥有或愿意安装[Go 1.12](https://golang.org/dl/)及以上版本,可以使用更为方便快捷的[Hugo Modules](#使用hugo-modules安装)进行安装。
3849
39-
使用Git Submodule安装时您只需在项目位置下执行
50+
使用Git Submodules安装时您只需在项目位置下执行
4051

4152
```shell
4253
git submodule add https://github.com/wangchucheng/hugo-eureka.git themes/eureka

zh/update.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,13 @@ aliases:
2121

2222
> 如果你的区域存在难以访问GitHub的问题,你可以将所有涉及到GitHub的网址替换为[Gitee镜像](https://gitee.com/wangchucheng/hugo-eureka/)。例如将`https://github.com/wangchucheng/hugo-eureka/`替换为`https://gitee.com/wangchucheng/hugo-eureka/`即可。
2323
24-
目前我们可以通过`Git Submodule``Hugo Modules`两种方式安装Eureka。接下来你将了解到如何更新Eureka。需要注意的是,你只能通过与安装相同的方式进行更新。
24+
目前我们可以通过`Git Submodules``Hugo Modules`两种方式安装Eureka。接下来你将了解到如何更新Eureka。需要注意的是,你只能通过与安装相同的方式进行更新。
2525

26-
## 使用Git Submodule更新
26+
## 使用Git Submodules更新
2727

28-
> 如果当前环境下拥有或愿意安装[Go 1.12](https://golang.org/dl/)及以上版本,可以[迁移至Hugo Modules](#由git-submodule迁移至hugo-modules)
28+
> 如果当前环境下拥有或愿意安装[Go 1.12](https://golang.org/dl/)及以上版本,可以[迁移至Hugo Modules](#由git-submodules迁移至hugo-modules)
2929
30-
使用Git Submodule更新只需在项目根目录下执行
30+
使用Git Submodules更新只需在项目根目录下执行
3131

3232
```shell
3333
cd themes/eureka
@@ -55,17 +55,17 @@ hugo mod get github.com/wangchucheng/hugo-eureka@<eureka_version>
5555

5656
Eureka的历史版本你可以在[Releases](https://github.com/wangchucheng/hugo-eureka/releases)中进行查看。
5757

58-
## 由Git Submodule迁移至Hugo Modules
58+
## 由Git Submodules迁移至Hugo Modules
5959

60-
由于Hugo Modules在管理上比Git Submodule更为方便快捷且Hugo Modules为Hugo推荐的添加主题的方式。推荐所有在当前环境下拥有或愿意安装[Go 1.12](https://golang.org/dl/)及以上版本的用户迁移至Hugo Modules。
60+
由于Hugo Modules在管理上比Git Submodules更为方便快捷且Hugo Modules为Hugo推荐的添加主题的方式。推荐所有在当前环境下拥有或愿意安装[Go 1.12](https://golang.org/dl/)及以上版本的用户迁移至Hugo Modules。
6161

6262
### 安装Go
6363

6464
如需使用Hugo Modules的绝大部分功能,你需要拥有Go 1.12及以上版本。可以在[Go官网](https://golang.org/dl/)进行安装。
6565

66-
### 删除Git Submodule
66+
### 删除Git Submodules
6767

68-
删除Git Submodule你只需
68+
删除Git Submodules你只需
6969

7070
```shell
7171
git submodule deinit -f -- themes/eureka
@@ -85,7 +85,7 @@ hugo mod init <module_name>
8585

8686
最后将`config/_default/config.yaml`中的`theme: eureka`注释并将`theme: github.com/wangchucheng/hugo-eureka`取消注释。
8787

88-
这时你已经完成了由Git Submodule到Hugo Modules的迁移。
88+
这时你已经完成了由Git Submodules到Hugo Modules的迁移。
8989

9090
---
9191

0 commit comments

Comments
 (0)