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
+30-18Lines changed: 30 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -167,7 +167,7 @@ lazyload:
167
167
168
168
`loading_img`: The placeholder image when loading
169
169
170
-
`onlypost`: If true, only enable lazyload on the post page. For custom pages, you can set `lazyload: true` in [Front-matter](https://hexo.io/zh-cn/docs/front-matter)
170
+
`onlypost`: If true, only enable lazyload on the post page. For custom pages, you can set `lazyload: true` in [front-matter](https://hexo.io/zh-cn/docs/front-matter)
171
171
172
172
`offset_factor`: The factor of viewport height that triggers loading
173
173
@@ -305,7 +305,7 @@ open_graph:
305
305
fb_app_id:
306
306
```
307
307
308
-
In addition, you can set fields in [Front-matter](https://hexo.io/docs/front-matter) to specify the OpenGraph property of a single page:
308
+
In addition, you can set fields in [front-matter](https://hexo.io/docs/front-matter) to specify the OpenGraph property of a single page:
309
309
310
310
```yaml
311
311
---
@@ -402,7 +402,7 @@ Part of the content as an excerpt
402
402
The rest of the text
403
403
```
404
404
405
-
Or you can set `excerpt` in [Front-matter](https://hexo.io/docs/front-matter):
405
+
Or you can set `excerpt` in [front-matter](https://hexo.io/docs/front-matter):
406
406
407
407
```yaml
408
408
---
@@ -447,7 +447,7 @@ index:
447
447
448
448
### Hide Posts
449
449
450
-
If you want to hide some posts on the index page, you can set `hide: true` at the [Front-matter](https://hexo.io/docs/front-matter) of the post.
450
+
If you want to hide some posts, you can set `hide: true` at the [front-matter](https://hexo.io/docs/front-matter) of the post.
451
451
452
452
```yaml
453
453
---
@@ -459,14 +459,26 @@ hide: true
459
459
This is post content
460
460
```
461
461
462
-
:::tip
463
-
Hiding makes the post invisible in both category page and tag page.
464
-
You can still enter post link.
465
-
:::
462
+
`hide`makes the post invisible on all pages.
463
+
But you can still enter post link.
464
+
465
+
### Archive Posts
466
+
467
+
If you want to makes the post invisible on index pages, you can set `archive: true` at the [front-matter](https://hexo.io/docs/front-matter) of the post.
468
+
469
+
```yaml
470
+
---
471
+
title: post title
472
+
index_img: /img/example.jpg
473
+
date: 2019-10-10 10:00:00
474
+
archive: true
475
+
---
476
+
This is post content
477
+
```
466
478
467
479
### Sort Posts
468
480
469
-
If you want to sort posts on the index page, you can set `sticky` at the [Front-matter](https://hexo.io/docs/front-matter) of the post, the premise is `hexo-generator-index` >= 2.0.0.
481
+
If you want to sort posts on the index page, you can set `sticky` at the [front-matter](https://hexo.io/docs/front-matter) of the post, the premise is `hexo-generator-index` >= 2.0.0.
470
482
471
483
```yaml
472
484
---
@@ -495,7 +507,7 @@ index:
495
507
496
508
### Index Image
497
509
498
-
You can define it at [Front-matter](https://hexo.io/docs/front-matter) of a post.
510
+
You can define it at [front-matter](https://hexo.io/docs/front-matter) of a post.
499
511
500
512
```yaml
501
513
---
@@ -522,7 +534,7 @@ When `default_index_img` and `index_img` are empty, no image will be displayed o
522
534
523
535
### Banner Image
524
536
525
-
The default display of `post.banner_img` in **theme config**, you can set `banner_img` via [Front-matter](https://hexo.io/zh-cn/docs/front-matter) to set it separately:
537
+
The default display of `post.banner_img` in **theme config**, you can set `banner_img` via [front-matter](https://hexo.io/zh-cn/docs/front-matter) to set it separately:
526
538
527
539
```yaml
528
540
---
@@ -641,7 +653,7 @@ If you want to import a new comment plugin, you can add `<script>` through [Cust
641
653
If your comment area is not displayed, there may be throwing some errors, you can find out the reason in the console of your browser.
642
654
:::
643
655
644
-
If you want to disable comment plugin on a post page, or want to enable comments on a custom page, you can set `comment: false` or `comment: 'type'` into [Front-matter](https://hexo.io/zh-cn/docs/front-matter).
656
+
If you want to disable comment plugin on a post page, or want to enable comments on a custom page, you can set `comment: false` or `comment: 'type'` into [front-matter](https://hexo.io/zh-cn/docs/front-matter).
645
657
646
658
For example, enable comment plugin on the about page:
647
659
@@ -822,7 +834,7 @@ post:
822
834
engine: mathjax
823
835
```
824
836
825
-
if `specific`: true，you should add `math: true` into [Front-matter](https://hexo.io/docs/front-matter) , and then the typesetting will be display on post page, and it can improve the speed of page load.
837
+
if `specific`: true，you should add `math: true` into [front-matter](https://hexo.io/docs/front-matter) , and then the typesetting will be display on post page, and it can improve the speed of page load.
826
838
827
839
`engine`: engine for typesetting, `mathjax` or `katex` is supported.
828
840
@@ -865,7 +877,7 @@ $$
865
877
:::warning
866
878
- You can't install more than one renderer, and can't install plugins such as `hexo-math` or `hexo-katex`.
867
879
- If your typesetting can't display correctly, you can check the below steps.
868
-
- The custom page doesn't load math by default, you need to specify `math: true` into [Front-matter](https://hexo.io/docs/front-matter) to ues it.
880
+
- The custom page doesn't load math by default, you need to specify `math: true` into [front-matter](https://hexo.io/docs/front-matter) to ues it.
`specific`: If true, only set `mermaid: true` into Front-matter will enable mermaid, to load faster when the page does not contain mermaid
897
+
`specific`: If true, only set `mermaid: true` into front-matter will enable mermaid, to load faster when the page does not contain mermaid
886
898
887
899
`options`: API options, see [mermaidAPI.js](http://mermaid-js.github.io/mermaid/#/mermaidAPI)
888
900
@@ -1003,7 +1015,7 @@ about:
1003
1015
1004
1016
### Comment
1005
1017
1006
-
Enable comment plugin via the [Front-matter](https://hexo.io/zh-cn/docs/front-matter) set `comment: bool` to enable the comment plugin, or set `comment: 'type'`to enable the specified comment plugin.
1018
+
Enable comment plugin via the [front-matter](https://hexo.io/zh-cn/docs/front-matter) set `comment: bool` to enable the comment plugin, or set `comment: 'type'`to enable the specified comment plugin.
1007
1019
1008
1020
```yaml
1009
1021
---
@@ -1087,7 +1099,7 @@ page:
1087
1099
banner_mask_alpha: 0.3
1088
1100
```
1089
1101
1090
-
Also set it in [Front-matter](https://hexo.io/zh-cn/docs/front-matter):
1102
+
Also set it in [front-matter](https://hexo.io/zh-cn/docs/front-matter):
1091
1103
1092
1104
```yaml
1093
1105
---
@@ -1102,7 +1114,7 @@ Markdown or HTML
1102
1114
1103
1115
### Comment
1104
1116
1105
-
Enable comment plugin in the same way as the about page, via the [Front-matter](https://hexo.io/zh-cn/docs/front-matter), set `comment: bool` to enable the comment plugin, or set `comment: 'type'`to enable the specified comment plugin.
1117
+
Enable comment plugin in the same way as the about page, via the [front-matter](https://hexo.io/zh-cn/docs/front-matter), set `comment: bool` to enable the comment plugin, or set `comment: 'type'`to enable the specified comment plugin.
0 commit comments