Skip to content

Commit f59fb4e

Browse files
authored
docs: update docs for v0.3.0 (#905)
1 parent eb0c78b commit f59fb4e

File tree

6 files changed

+40
-25
lines changed

6 files changed

+40
-25
lines changed

archetypes/default.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ rssFullText: false
2929
toc:
3030
enable: true
3131
auto: true
32+
keepStatic: false
3233
code:
3334
copy: true
3435
maxShownLines: 50

exampleSite/content/posts/theme-documentation-basics/index.en.md

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,10 @@ Discover what the Hugo - **LoveIt** theme is all about and the core-concepts beh
2929

3030
Thanks to the simplicity of Hugo, [Hugo](https://gohugo.io/) is the only dependency of this theme.
3131

32-
Just install latest **extended edition** of [:(far fa-file-archive fa-fw): Hugo (> 0.128.0)](https://gohugo.io/getting-started/installing/) for your OS (**Windows**, **Linux**, **macOS**).
32+
Just install latest edition of [:(far fa-file-archive fa-fw): Hugo](https://gohugo.io/getting-started/installing/) for your OS (**Windows**, **Linux**, **macOS**).
3333

34-
{{< admonition note "Why need to use Hugo **extended edition**" >}}
35-
Since some features of this theme need to processes :(fab fa-sass fa-fw): SCSS to :(fab fa-css3 fa-fw): CSS, you need to use Hugo **extended edition** for correct rendering.
34+
{{< admonition note "When you need to use Hugo extended edition?" false >}}
35+
When you want [style customization](#style-customization), you need to use the Hugo **extended edition** for correct rendering.
3636

3737
![Hugo extended edition](hugo-extended-edition.png "Hugo extended edition")
3838
{{< /admonition >}}
@@ -52,9 +52,9 @@ cd my_website
5252

5353
### 2.2 Install the Theme
5454

55-
The **LoveIt** themes repository is: [https://github.com/dillonzq/LoveIt](https://github.com/dillonzq/LoveIt).
55+
The **LoveIt** theme's repository is: [https://github.com/dillonzq/LoveIt](https://github.com/dillonzq/LoveIt).
5656

57-
You can download the [latest release :(far fa-file-archive fa-fw): .zip file](https://github.com/dillonzq/LoveIt/releases) of the theme and extract it in the `themes` directory.
57+
You can download the [release :(far fa-file-archive fa-fw): .zip file](https://github.com/dillonzq/LoveIt/releases) of the theme and extract it in the `themes` directory.
5858

5959
Alternatively, clone this repository to the `themes` directory:
6060

@@ -69,6 +69,16 @@ git init
6969
git submodule add https://github.com/dillonzq/LoveIt.git themes/LoveIt
7070
```
7171

72+
{{< admonition note "LoveIt theme's compatibility" >}}
73+
74+
| LoveIt branch or version | Supported Hugo versions |
75+
|:---- |:----:|
76+
| master(Unstable) | ≥ 0.128.0 |
77+
| **0.3.X(Recommended)** | 0.128.0 - 0.143.1 |
78+
| 0.2.X(Outdated) | 0.68.0 - 0.127.0 |
79+
80+
{{< /admonition >}}
81+
7282
### 2.3 Basic Configuration {#basic-configuration}
7383

7484
The following is a basic configuration for the LoveIt theme:
@@ -208,8 +218,6 @@ languageName = "English"
208218
# whether to include Chinese/Japanese/Korean
209219
hasCJKLanguage = false
210220

211-
# google analytics code [UA-XXXXXXXX-X]
212-
googleAnalytics = ""
213221
# copyright description used only for seo schema
214222
copyright = ""
215223

@@ -511,7 +519,7 @@ ignoreErrors = ["error-remote-getjson", "error-missing-instagram-accesstoken"]
511519
# whether to enable the table of the contents
512520
enable = true
513521
# {{< version 0.2.9 >}} whether to keep the static table of the contents in front of the post
514-
keepStatic = true
522+
keepStatic = false
515523
# whether to make the table of the contents in the sidebar automatically collapsed
516524
auto = true
517525
# {{< version 0.2.0 changed >}} {{< link "https://katex.org/" KaTeX >}} mathematical formulas
@@ -899,11 +907,12 @@ into `/static`. They’re easily created via [https://realfavicongenerator.net/]
899907

900908
Customize `browserconfig.xml` and `site.webmanifest` to set theme-color and background-color.
901909

902-
### 3.3 Style Customization
910+
### 3.3 Style Customization {#style-customization}
903911

904912
{{< version 0.2.8 changed >}}
905913

906-
{{< admonition >}}
914+
{{< admonition note "Hugo extended version is necessary" >}}
915+
Since Hugo need to processes :(fab fa-sass fa-fw): SCSS to :(fab fa-css3 fa-fw): CSS,
907916
Hugo **extended** version is necessary for the style customization.
908917
{{< /admonition >}}
909918

exampleSite/content/posts/theme-documentation-basics/index.zh-cn.md

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,10 @@ toc:
2929

3030
由于 Hugo 提供的便利性, [Hugo](https://gohugo.io/) 是这个主题唯一的依赖.
3131

32-
直接安装满足你操作系统 (**Windows**, **Linux**, **macOS**) 的最新 **extended** 版本 [:(far fa-file-archive fa-fw): Hugo (> 0.128.0)](https://gohugo.io/getting-started/installing/).
32+
直接安装满足你操作系统 (**Windows**, **Linux**, **macOS**) 的最新版本 [:(far fa-file-archive fa-fw): Hugo](https://gohugo.io/getting-started/installing/).
3333

34-
{{< admonition note "为什么需要使用 Hugo extended 版本" >}}
35-
由于这个主题的一些特性需要将 :(fab fa-sass fa-fw): SCSS 转换为 :(fab fa-css3 fa-fw): CSS, 你需要使用 Hugo **extended** 版本来获得正确的渲染效果.
34+
{{< admonition note "什么时候需要使用 Hugo extended 版本?" false >}}
35+
当你需要[自定义样式](#style-customization)时, 你要使用 Hugo **extended** 版本来获得正确的渲染效果.
3636

3737
![Hugo extended 版本](hugo-extended-edition.png "Hugo extended 版本")
3838
{{< /admonition >}}
@@ -54,7 +54,7 @@ cd my_website
5454

5555
**LoveIt** 主题的仓库是: [https://github.com/dillonzq/LoveIt](https://github.com/dillonzq/LoveIt).
5656

57-
你可以下载主题的 [最新版本 :(far fa-file-archive fa-fw): .zip 文件](https://github.com/dillonzq/LoveIt/releases) 并且解压放到 `themes` 目录.
57+
你可以下载主题的 [发布版本 :(far fa-file-archive fa-fw): .zip 文件](https://github.com/dillonzq/LoveIt/releases) 并且解压放到 `themes` 目录.
5858

5959
另外, 也可以直接把这个主题克隆到 `themes` 目录:
6060

@@ -69,6 +69,16 @@ git init
6969
git submodule add https://github.com/dillonzq/LoveIt.git themes/LoveIt
7070
```
7171

72+
{{< admonition note "主题的兼容性" >}}
73+
74+
| 分支或版本 | 支持的 Hugo 版本 |
75+
|:---- |:----:|
76+
| master(不稳定) | ≥ 0.128.0 |
77+
| **0.3.X(推荐)** | 0.128.0 - 0.143.1 |
78+
| 0.2.X(过时) | 0.68.0 - 0.127.0 |
79+
80+
{{< /admonition >}}
81+
7282
### 2.3 基础配置 {#basic-configuration}
7383

7484
以下是 LoveIt 主题的基本配置:
@@ -210,8 +220,6 @@ languageName = "简体中文"
210220
# 是否包括中日韩文字
211221
hasCJKLanguage = true
212222

213-
# 谷歌分析代号 [UA-XXXXXXXX-X]
214-
googleAnalytics = ""
215223
# 版权描述,仅仅用于 SEO
216224
copyright = ""
217225

@@ -513,7 +521,7 @@ ignoreErrors = ["error-remote-getjson", "error-missing-instagram-accesstoken"]
513521
# 是否使用目录
514522
enable = true
515523
# {{< version 0.2.9 >}} 是否保持使用文章前面的静态目录
516-
keepStatic = true
524+
keepStatic = false
517525
# 是否使侧边目录自动折叠展开
518526
auto = true
519527
# {{< version 0.2.0 >}} 代码配置
@@ -902,12 +910,12 @@ ignoreErrors = ["error-remote-getjson", "error-missing-instagram-accesstoken"]
902910

903911
可以自定义 `browserconfig.xml``site.webmanifest` 文件来设置 theme-color 和 background-color.
904912

905-
### 3.3 自定义样式
913+
### 3.3 自定义样式 {#style-customization}
906914

907915
{{< version 0.2.8 changed >}}
908916

909-
{{< admonition >}}
910-
Hugo **extended** 版本对于自定义样式是必需的.
917+
{{< admonition note "Hugo extended 版本是必需的" >}}
918+
由于需要将 :(fab fa-sass fa-fw): SCSS 转换为 :(fab fa-css3 fa-fw): CSS, Hugo **extended** 版本对于自定义样式是必需的.
911919
{{< /admonition >}}
912920

913921
通过定义自定义 `.scss` 样式文件, **LoveIt** 主题支持可配置的样式.

exampleSite/hugo.toml

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,6 @@ languageName = "English"
2424
# 是否包括中日韩文字
2525
hasCJKLanguage = false
2626

27-
# google analytics code [UA-XXXXXXXX-X]
28-
# 谷歌分析代号 [UA-XXXXXXXX-X]
29-
googleAnalytics = ""
3027
# copyright description used only for seo schema
3128
# 版权描述,仅仅用于 SEO
3229
copyright = ""

layouts/partials/init.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
{{- .Scratch.Set "version" "0.2.11" -}}
1+
{{- .Scratch.Set "version" "0.3.0" -}}
22

33
{{- $params := .Params | merge .Site.Params.page -}}
44

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "loveit-src",
3-
"version": "0.2.11",
3+
"version": "0.3.0",
44
"description": "LoveIt theme source file",
55
"private": true,
66
"devDependencies": {

0 commit comments

Comments
 (0)