You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/en/guide/README.md
+24-24Lines changed: 24 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@
4
4
5
5
## About this Guide
6
6
7
-
This guide is only for partial configuration instructions, **Not for the all configs**, For specific configuration requirements, please refer to the comments in the file `_config.yml` at the path of the theme. For more help, Please write your questions at [issues](https://github.com/fluid-dev/hexo-theme-fluid/issues/new).
7
+
**This guide is only for partial configuration instructions, not for the all configs**, for specific configuration requirements, please refer to the comments in the file `_config.yml` at the path of the theme. For more help, Please write your questions at [issues](https://github.com/fluid-dev/hexo-theme-fluid/issues/new).
8
8
9
9
:::tip
10
10
About the config file in the guide:
@@ -14,21 +14,21 @@ About the config file in the guide:
14
14
15
15
## Global
16
16
17
-
### Override Configuration
17
+
### Configuration Override
18
18
19
19
:::tip
20
-
Override configuration can avoid losing your customized configuration when updating Fluid.
20
+
Configuration override can avoid losing your customized configuration while updating Fluid.
21
21
22
-
Users who installed Fluid via Npm can ignore it, other users are recommended to learn to use it.
22
+
Users who installed Fluid via npm can ignore it, while we recommended other users to learn to use it.
23
23
:::
24
24
25
-
If your Hexo version >= 5.0.0, create `_config.fluid.yml` in the blog directory and copy the content of [_config.yml](https://github.com/fluid-dev/hexo-theme-fluid/blob/master/_config.yml)
25
+
If your Hexo version >= 5.0.0(`hexo -v`), please create `_config.fluid.yml` in the blog directory and copy the content of our theme's[_config.yml](https://github.com/fluid-dev/hexo-theme-fluid/blob/master/_config.yml) into it.
26
26
27
27
Notice:
28
-
- The configuration existing in `_config.fluid.yml` is of high priority, modifying `_config.yml` is useless.
28
+
- The configuration existing in `_config.fluid.yml` is of high priority, so modifying `_config.yml` is useless.
29
29
- There may be configuration changes in the upgraded theme, you need to manually modify `_config.fluid.yml` synchronously.
30
-
- You can use `hexo g -- debug` to check override configuration.
31
-
- If you want to cancel some configurations, you should do this:
30
+
- You can use `hexo g -- debug` to check configuration override.
31
+
- If you want to cancel some configurations, you should:
32
32
33
33
```yaml
34
34
about:
@@ -38,7 +38,7 @@ about:
38
38
```
39
39
40
40
<details>
41
-
<summary>Hexo version < 5.0.0 click here</summary>
41
+
<summary>If your Hexo version < 5.0.0, look here</summary>
42
42
43
43
You should make sure that your version of *Hexo* is not lower than *3.0*, because of the function about [data-files](https://hexo.io/docs/data-files.html)
44
44
@@ -64,20 +64,20 @@ static_prefix:
64
64
65
65
### Local Search
66
66
67
-
- The hexo-generator-search plug-in has been integrated, please disable it if you had installed other search plug-ins to avoid generating redundant index files.
67
+
- The `hexo-generator-search` plug-in has already been integrated, disable it if you had installed other search plug-ins to avoid generating redundant index files.
68
68
69
69
- By default, `local-search.xml` is generated in the root directory and being used.
70
70
71
71
### Banner Image
72
72
73
-
- image source
73
+
- Image source
74
74
75
-
There is `banner_img` property for every pages in the **theme config**, it can be assigned a relative path or url.
75
+
There is `banner_img` property for every pages in the **theme config**, which can be assigned as a relative path or url.
76
76
77
77
To use a local image:
78
78
79
79
```yaml
80
-
banner_img: /img/bg/example.jpg # stored at /source/img/bg/example.jpg
80
+
banner_img: /img/bg/example.jpg # At /source/img/bg/example.jpg
You can define the path yourself, but it should be in the `source` directory
91
91
92
-
The source directory of blog and fluid will be merged eventually, so the source of blog is preferred.
92
+
The source directory of blog and Fluid will be merged eventually, so the source of blog is preferred.
93
93
:::
94
94
95
-
- height
95
+
- Image height
96
96
97
97
For different people's preferences, you can control the height of the `banner_img` on the page.
98
98
99
99
You can set `banner_img_height` for every pages in **theme config** with a valid range of 0 - 100. We think it is better to choose a number bigger than 70.
100
100
101
-
- alpha of mask
101
+
- Alpha of mask
102
102
103
103
You can set `banner_mask_alpha` for every pages in **theme config** with a valid range of 0 - 1.0. 0 is completely transparent (no mask) while 1 is completely opaque.
104
104
@@ -108,18 +108,18 @@ The banner of each post page can be set independently. You can read the config a
The title is on the left side of the banner. It can be set by modifying the property `title` in file **site config**, which is also the title of the browser's tab.
114
114
115
115
If you want to set varies titles for different pages, you can change the **theme config** as follows:
Then create `_config.fluid.yml` in the blog directory and copy the content of [_config.yml](https://github.com/fluid-dev/hexo-theme-fluid/blob/master/_config.yml)
30
30
31
-
#### Method B
31
+
#### via releases
32
32
33
33
Download the [latest release](https://github.com/fluid-dev/hexo-theme-fluid/releases), then extract it to `themes` directory and renamed to `fluid`.
34
34
35
-
### Set theme
35
+
### Setting theme
36
36
37
37
Edit `_config.yml` in the blog root directory as follows:
38
38
39
39
```yaml
40
40
theme: fluid
41
41
```
42
42
43
-
### Create about page
43
+
### Creating the About Page
44
44
45
45
The about page needs to be created manually:
46
46
47
47
```bash
48
48
hexo new page about
49
49
```
50
50
51
-
Then edit `/source/about/index.md` and add `layout` attribute.
51
+
Then edit `/source/about/index.md`under the blog directory and add `layout` attribute.
52
52
53
53
The modified example is as follows:
54
54
@@ -58,34 +58,34 @@ title: This is a title
58
58
layout: about
59
59
---
60
60
61
-
You can write the content here, support Markdown, HTML
61
+
You can write the content here, with the support of Markdown and HTML
62
62
```
63
63
64
64
:::warning
65
-
`layout: about` must exists and can not be modified as other values, otherwise avatar and other styles will not be shown.
65
+
`layout: about` must exist and **can not** be modified as other values, otherwise avatar and other styles **will not be shown**.
66
66
:::
67
67
68
-
## Theme Upgrade
68
+
## Upgrading Fluid via...
69
69
70
-
#### Method A
70
+
#### npm
71
71
72
-
> Applicable for Npm-installed theme.
72
+
> Applicable for npm-installed theme.
73
73
74
74
Execute the command in your blog directory:
75
75
76
76
```bash
77
77
npm update --save hexo-theme-fluid
78
78
```
79
79
80
-
#### Method B
80
+
#### files
81
81
82
82
> Applicable for installed theme via release and all codes have not been modified.
83
83
84
-
1. Backup your config files. We recommend you to use [override configuration](/en/guide/#override-configuration).
84
+
1. Backup your config files. We recommend you to use [configuration override](/en/guide/#configuration-override).
85
85
86
86
2. Download the [latest release](https://github.com/fluid-dev/hexo-theme-fluid/releases), then replace the fluid directory.
87
87
88
-
#### Method C
88
+
#### or if you changed codes
89
89
90
90
> Applicable to cases where some codes have been modified, or you want to pull the master branch.
0 commit comments