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
+14-14Lines changed: 14 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,14 +19,14 @@ About the config file in the guide:
19
19
:::tip
20
20
Override configuration can avoid losing your customized configuration when updating Fluid.
21
21
22
-
Users who install 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, other users are recommended to learn to use it.
23
23
:::
24
24
25
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)
26
26
27
27
Notice:
28
28
- The configuration existing in `_config.fluid.yml` is of high priority, modifying `_config.yml` is useless.
29
-
- There may be configuration changes in the theme of upgrading, you need to manually modify `_config.fluid.yml` synchronously.
29
+
- There may be configuration changes in the upgraded theme, you need to manually modify `_config.fluid.yml` synchronously.
30
30
- You can use `hexo g -- debug` to check override configuration.
31
31
- If you want to cancel some configurations, you should do this:
32
32
@@ -64,53 +64,53 @@ static_prefix:
64
64
65
65
### Local Search
66
66
67
-
- The hexo-generator-search plug-in has been integrated, please close if you have installed other search plug-ins to avoid generating redundant index files.
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.
68
68
69
-
- By default, `local-search.xml` is generated and used in the root directory.
69
+
- By default, `local-search.xml` is generated in the root directory and being used.
70
70
71
71
### Banner Image
72
72
73
-
- img src
73
+
- image source
74
74
75
-
there is `banner_img` item for every pages in the **theme config**, you can use a relative path or url.
75
+
There is `banner_img` property for every pages in the **theme config**, it can be assigned a relative path or url.
76
76
77
-
use a local image:
77
+
To use a local image:
78
78
79
79
```yaml
80
80
banner_img: /img/bg/example.jpg # stored at /source/img/bg/example.jpg
81
81
```
82
82
83
-
use a url:
83
+
To use a url:
84
84
85
85
```yaml
86
86
banner_img: https://static.zkqiang.cn/example.jpg
87
87
```
88
88
89
89
::: tip
90
-
You can define the ain path yourself, but it should be in the `source` directory
90
+
You can define the path yourself, but it should be in the `source` directory
91
91
92
92
The source directory of blog and fluid will be merged eventually, so the source of blog is preferred.
93
93
:::
94
94
95
95
- height
96
96
97
-
For different people's thoughts, you can control the height of the `banner_img` on the page.
97
+
For different people's preferences, you can control the height of the `banner_img` on the page.
98
98
99
-
You can set a value to `banner_img_height` for every pages in **theme config**, 0 - 100 is valuable, We think it is better to choose a number bigger than 70.
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
101
- alpha of mask
102
102
103
-
You can set a value `banner_mask_alpha` for every pages in **theme config**, 0 - 1.0 is valuable, 0 is completely transparent (no mask), 1 is completely opaque
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
105
105
::: tip
106
-
Each post page can define its banner independently, you can read the config about the posts for more details.
106
+
The banner of each post page can be set independently. You can read the config about the posts for more details.
The title is on the left of the banner, Its value can set by the attribute `title` in file **site config**, which is also the title of the browser's tab.
113
+
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:
If you don't have a hexo blog, please follow [Hexo Docs](https://hexo.io/docs/) to install and initialize your blog。
17
+
If you don't have a hexo blog, please follow [Hexo Docs](https://hexo.io/docs/) to install and initialize your blog.
18
18
19
-
####Download Fluid
19
+
### Download Fluid
20
20
21
-
#### Way A
21
+
#### Method A
22
22
23
-
If your Hexo version >= 5.0.0, you can be installed via Npm:
23
+
Installing directly via Npm is recommended for Hexo version 5.0.0 and above. Run the following command in the blog directory:
24
24
25
25
```sh
26
26
npm install --save hexo-theme-fluid
27
27
```
28
28
29
29
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
-
#### Way B
31
+
#### Method B
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
@@ -61,27 +61,31 @@ layout: about
61
61
You can write the content here, support Markdown, HTML
62
62
```
63
63
64
+
:::warning
65
+
`layout: about` must exists and can not be modified as other values, otherwise avatar and other styles will not be shown.
66
+
:::
67
+
64
68
## Theme Upgrade
65
69
66
-
#### Way A
70
+
#### Method A
67
71
68
-
> Applicable to installed theme via Npm.
72
+
> Applicable for Npm-installed theme.
69
73
70
-
Execute the command in your blog directory:
74
+
Execute the command in your blog directory:
71
75
72
76
```bash
73
77
npm update --save hexo-theme-fluid
74
78
```
75
79
76
-
#### Way B
80
+
#### Method B
77
81
78
-
> Applicable to installed theme via release and all codes have not been modified.
82
+
> Applicable for installed theme via release and all codes have not been modified.
79
83
80
84
1. Backup your config files. We recommend you to use [override configuration](/en/guide/#override-configuration).
81
85
82
86
2. Download the [latest release](https://github.com/fluid-dev/hexo-theme-fluid/releases), then replace the fluid directory.
83
87
84
-
#### Way C
88
+
#### Method C
85
89
86
90
> Applicable to cases where some codes have been modified, or you want to pull the master branch.
0 commit comments