Skip to content

Commit cf9d0e7

Browse files
committed
chore: update README
1 parent 5058a5b commit cf9d0e7

File tree

2 files changed

+153
-29
lines changed

2 files changed

+153
-29
lines changed

README.en.md

Lines changed: 68 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -71,15 +71,15 @@ A combination of [landscape](https://github.com/hexojs/hexo-theme-landscape)、[
7171
- 👾 Live2D / Live2D-widgets integration
7272

7373
### Navigation & Structure
74-
- 📑 Table of Contents (TOC)
74+
- 📑 Table of Contents
7575
- 🔄 PJAX support
7676
- 🔧 ServiceWorker implementation
7777
- 📰 RSS feed
7878

7979
### Design & Customization
8080
- 🎨 Icon support:
8181
- Iconfont
82-
- FontAwesome
82+
- FontAwesome7
8383
- 🔗 Built-in tag plugins:
8484
- Internal links
8585
- External links
@@ -211,6 +211,46 @@ sticky: true
211211
```
212212

213213
</details>
214+
215+
<details>
216+
<summary>Footer</summary>
217+
218+
### Footer
219+
220+
#### Basic Information
221+
222+
The footer section allows you to configure basic display information and statistics.
223+
224+
```yaml
225+
footer:
226+
since: 2020 # The starting year displayed in the copyright information (e.g., 2020-current year)
227+
powered: true # Whether to display copyright information
228+
count: true # Whether to display word count and reading time statistics
229+
busuanzi: true # Whether to enable Busuanzi visitor counting statistics
230+
```
231+
232+
#### ICP Filing
233+
234+
For websites hosted in mainland China, you can display ICP filing information as required by regulations.
235+
236+
```yaml
237+
icp:
238+
icpnumber: # ICP filing number
239+
beian: # Public Security Bureau filing number
240+
recordcode: # Record code parameter from the Public Security Bureau filing link
241+
```
242+
243+
#### Moe ICP Filing (v1.9.1+)
244+
245+
[Moe ICP Filing](https://icp.gov.moe/)
246+
247+
```yaml
248+
moe_icp:
249+
icpnumber: # Moe ICP filing number
250+
```
251+
252+
</details>
253+
214254
<details>
215255
<summary>Code Blocks</summary>
216256

@@ -807,6 +847,15 @@ home_categories:
807847

808848
Uses Aplayer + Meting (optional), disabled by default
809849

850+
#### Music Player Position (v1.9.1+)
851+
852+
Default is after sidebar
853+
854+
```yml
855+
player:
856+
position: before_sidebar # before_sidebar / after_sidebar / after_widget
857+
```
858+
810859
##### Pure Aplayer
811860

812861
Set `player.aplayer.enable` to `true` and configure `player.aplayer.options` according to [Aplayer Docs](https://aplayer.js.org/#/home?id=options)
@@ -872,7 +921,21 @@ share:
872921
# - weixin
873922
```
874923

875-
For `weixin`, it generates a share card with QR code that can be saved locally and shared to WeChat Moments (Note: when the article cover has cross-origin issues, html-to-image cannot correctly generate cards with images!)
924+
For `weixin`, it generates a share card with QR code that can be saved locally and shared to WeChat Moments (Note: when the article cover has cross-origin issues, snapdom cannot correctly generate cards with images!)
925+
926+
#### Injector (v1.5.1+)
927+
928+
Used to inject custom code, similar to [Hexo#Injector](https://hexo.io/api/injector), supports `head`, `body` and `sidebar` injection
929+
930+
```yaml
931+
injector:
932+
head_begin: # Inject code snippet right after <head>
933+
head_end: # Inject code snippet right before </head>
934+
body_begin: # Inject code snippet right after <body>
935+
body_end: # Inject code snippet right before </body>
936+
sidebar_begin: # Inject code snippet right after <aside>
937+
sidebar_end: # Inject code snippet right before </aside>
938+
```
876939

877940
</details>
878941

@@ -908,15 +971,15 @@ The first parameter is the article's `slug`; the second parameter (optional) is
908971

909972
The first parameter is the article title; the second parameter is the external link to the article; the third parameter (optional) is the cover image displayed on the card, if set to `auto` it will automatically use the default cover
910973

911-
#### Heat Map Card Article Heatmap (Experimental Feature in v1.7.0+)
974+
#### Heat Map Card Article Heatmap (v1.7.0+)
912975

913976
```yaml
914977
{% heatMapCard levelStandard %}
915978
```
916979

917980
The first parameter is the level standard for the heatmap (graded based on the word count of the articles), with the default value being `"1000,5000,10000"`.
918981

919-
#### tagRoulette
982+
#### tagRoulette (v1.9.0+)
920983

921984
```yaml
922985
{% heatMapCard tags icon %}

README.md

Lines changed: 85 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -70,15 +70,15 @@
7070
- 👾 Live2D / Live2D-widgets 集成
7171

7272
### 导航与结构
73-
- 📑 目录导航(TOC)
73+
- 📑 目录导航
7474
- 🔄 PJAX 支持
7575
- 🔧 ServiceWorker 实现
7676
- 📰 RSS 订阅
7777

7878
### 设计与自定义
7979
- 🎨 图标支持:
8080
- Iconfont
81-
- FontAwesome
81+
- FontAwesome7
8282
- 🔗 内置标签插件:
8383
- 内部链接
8484
- 外部链接
@@ -209,6 +209,44 @@ sticky: true
209209
---
210210
```
211211

212+
</details>
213+
<details>
214+
<summary>页脚</summary>
215+
216+
### 页脚
217+
218+
#### 基础信息
219+
220+
页脚部分允许您配置基本显示信息和统计数据
221+
222+
```yaml
223+
footer:
224+
since: 2020 # 在版权信息中显示的起始年份(例如:2020-当前年份)
225+
powered: true # 是否显示版权信息
226+
count: true # 是否显示字数统计和阅读时间信息
227+
busuanzi: true # 是否启用不蒜子访客统计功能
228+
```
229+
230+
#### ICP 备案
231+
232+
对于托管在中国大陆的网站,可以根据法规要求显示ICP备案信息
233+
234+
```yml
235+
icp:
236+
icpnumber: # ICP备案号
237+
beian: # 网安备案号
238+
recordcode: # 网安备案链接中的recordcode参数
239+
```
240+
241+
#### 萌国 ICP 备案 (v1.9.1+)
242+
243+
[萌国 ICP 备案](https://icp.gov.moe/)
244+
245+
```yml
246+
moe_icp:
247+
icpnumber: # 萌国ICP备案号
248+
```
249+
212250
</details>
213251
<details>
214252
<summary>代码块</summary>
@@ -706,17 +744,6 @@ srcset:
706744
media: "(min-width: 800px)"
707745
```
708746

709-
#### Quicklink(v0.2.3+)
710-
711-
默认关闭,打开后可以在用户停留在页面时预加载链接,提高用户体验
712-
```yml
713-
quicklink:
714-
enable: false
715-
timeout: 3000 # 预加载超时时间
716-
priority: true # 是否优先加载
717-
ignores: [] # 忽略的链接,仅支持字符串
718-
```
719-
720747
#### 文章版权声明(v0.2.0+)
721748

722749
默认关闭
@@ -741,6 +768,17 @@ copyright: true # 是否展示版权卡片?
741768
---
742769
```
743770

771+
#### Quicklink(v0.2.3+)
772+
773+
默认关闭,打开后可以在用户停留在页面时预加载链接,提高用户体验
774+
```yml
775+
quicklink:
776+
enable: false
777+
timeout: 3000 # 预加载超时时间
778+
priority: true # 是否优先加载
779+
ignores: [] # 忽略的链接,仅支持字符串
780+
```
781+
744782
#### 文章过期提醒(v0.2.4+)
745783

746784
默认关闭
@@ -802,6 +840,15 @@ home_categories:
802840

803841
使用 Aplayer + Meting(可选)默认关闭
804842

843+
#### 音乐播放器位置(v1.9.1+)
844+
845+
默认在 sidebar 之后
846+
847+
```yml
848+
player:
849+
position: before_sidebar # before_sidebar / after_sidebar / after_widget
850+
```
851+
805852
##### 纯Aplayer
806853

807854
将 `player.aplayer.enable` 设置为 `true`,并在 `player.aplayer.options` 中参考 [Aplayer Docs](https://aplayer.js.org/#/home?id=options) 进行配置
@@ -852,14 +899,6 @@ player:
852899
auto:
853900
```
854901

855-
#### Pangu 自动分割
856-
默认关闭,自动替你在文章中所有的中文字和半形的英文、数字、符号之间插入空白。
857-
858-
```yml
859-
pangu:
860-
enable: false
861-
```
862-
863902
#### 分享链接/卡片(v1.3.0+)
864903

865904
默认关闭,目前支持 `facebook`、`twitter`、`linkedin`、`reddit`、`weibo`、`qq`、`weixin`。
@@ -875,7 +914,29 @@ share:
875914
# - weixin
876915
```
877916

878-
`weixin` 状态下会生成带有二维码的分享卡片,可保存到本地后分享到微信朋友圈(注意,当文章封面存在跨域问题时无法使用 html-to-image 正确生成含图片的卡片!)
917+
`weixin` 状态下会生成带有二维码的分享卡片,可保存到本地后分享到微信朋友圈(注意,当文章封面存在跨域问题时无法使用 snapdom 正确生成含图片的卡片!)
918+
919+
#### 注入器(v1.5.1+)
920+
921+
用于注入自定义代码,其效果和 [Hexo#Injector](https://hexo.io/api/injector) 类似,支持 `head`、 `body` 和 `sidebar` 注入
922+
923+
```yaml
924+
injector:
925+
head_begin: # 在 <head> 标签后注入代码
926+
head_end: # 在 </head> 标签前注入代码
927+
body_begin: # 在 <body> 标签后注入代码
928+
body_end: # 在 </body> 标签前注入代码
929+
sidebar_begin: # 在 <aside> 标签后注入代码
930+
sidebar_end: # 在 </aside> 标签前注入代码
931+
```
932+
933+
#### Pangu 自动分割(v1.6.0+)
934+
默认关闭,自动替你在文章中所有的中文字和半形的英文、数字、符号之间插入空白。
935+
936+
```yml
937+
pangu:
938+
enable: false
939+
```
879940

880941
</details>
881942

@@ -911,15 +972,15 @@ share:
911972

912973
其中第一个参数为文章的标题;第二个参数为文章的外部链接,第三个参数(可选)为卡片展示的封面,如果设置为 `auto` 则自动使用缺省封面
913974

914-
#### heatMapCard 文章热力图 (v1.7.0+ 实验性功能)
975+
#### heatMapCard 文章热力图 (v1.7.0+)
915976

916977
```yaml
917978
{% heatMapCard levelStandard %}
918979
```
919980

920981
其中第一个参数为热力图的等级标准(按照文章字数分级),默认为 `"1000,5000,10000"`
921982

922-
#### tagRoulette 标签轮盘
983+
#### tagRoulette 标签轮盘 (v1.9.0+)
923984

924985
```yaml
925986
{% heatMapCard tags icon %}

0 commit comments

Comments
 (0)