Skip to content

Commit 39f4fe5

Browse files
author
白云苍狗
committed
📃 docs: 文档修改
1 parent 4ee06de commit 39f4fe5

File tree

3 files changed

+30
-27
lines changed

3 files changed

+30
-27
lines changed

docs/.vitepress/config.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -183,5 +183,8 @@ export default defineConfig({
183183
message: 'Released under the SATA | MIT License.',
184184
copyright: 'Copyright © 2022-PRESENT MaLuns',
185185
},
186+
outline: {
187+
level: [2, 3],
188+
},
186189
},
187190
});

docs/guide/config.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# 主题配置
22

3-
## 配置文件 async.yml
3+
## 配置文件
44

55
约定 > 配置
66

@@ -12,7 +12,7 @@
1212
请最好**不要****主题的任何文件**进行修改,除非您确认您拥有一定的开发能力或此后将不会对主题进行升级。
1313
:::
1414

15-
## 语言 Language
15+
## 语言配置
1616

1717
本主题内置了中英文两种语言,`zh-Hans``en`
1818

@@ -54,7 +54,7 @@ zh-Hans:
5454

5555
如果仅使用中文语言,除 `zh-Hans` 项均可删除。
5656

57-
## 主题模式 ThemeMode
57+
## 主题模式
5858

5959
- `default`:设置主题默认模式
6060
- `style-light`:亮色模式
@@ -76,7 +76,7 @@ theme:
7676

7777
:::
7878

79-
## 网站图标 Favicon
79+
## 网站图标
8080

8181
用于 logo、icon、PWA 安装图标配置。
8282

@@ -112,7 +112,7 @@ favicon:
112112

113113
:::
114114

115-
## 插件 Plugins
115+
## 插件配置
116116

117117
主题内置插件配置。
118118

@@ -166,7 +166,7 @@ assets:
166166

167167
:::
168168

169-
## 加速静态资源 CDN
169+
## CDN 配置
170170

171171
Content Delivery Network,统一加载网络资源,有利于提高网页加载速度。
172172

@@ -197,7 +197,7 @@ cdn:
197197

198198
:::
199199

200-
## 字体图标 Icon
200+
## 字体图标
201201

202202
本主题默认使用 Font Awesome 5 图标。
203203

@@ -246,7 +246,7 @@ assets:
246246
单色图标 和 多色图标是可以同时使用的,但是博客 UI 的**固定图标**只能根据 `type` 决定使用哪一种。
247247
:::
248248

249-
## 用户信息 User
249+
## 用户信息
250250

251251
用户基本信息,用于博主名称、头像、友链交换规则、站点运行计时等等。
252252

@@ -282,7 +282,7 @@ user:
282282

283283
:::
284284

285-
## 导航栏 TopBars
285+
## 导航栏
286286

287287
顶部导航的 logo 在 [favicon](#favicon) 中配置,主题切换按钮在 [主题模式](#主题模式) 中配置。
288288

@@ -312,7 +312,7 @@ top_bars:
312312

313313
:::
314314

315-
## 侧栏 Sidebar
315+
## 侧栏
316316

317317
### 社交图标
318318

@@ -372,7 +372,7 @@ sidebar:
372372
val: 18
373373
```
374374
375-
## 横幅 Banner
375+
## 横幅
376376
377377
每个页面横幅都可以自定义不同背景图、标语等,当您需要视频背景的时候,您的视频格式需要为 MP4、WebM 、Ogg 等格式。
378378
@@ -490,7 +490,7 @@ twikoo && danMu(
490490
)
491491
```
492492

493-
## 页脚 Footer
493+
## 页脚
494494

495495
此配置在 `v1.1.7+` 新增,以前版本在 [用户信息-user](#用户信息-user) 配置。
496496

@@ -576,11 +576,11 @@ footer:
576576
custom_text: Hosted by <a href="https://github.com" rel="noopener" target="_blank">Github Pages</a>
577577
```
578578

579-
## 文章 Article
579+
## 文章
580580

581581
这里是一些关于文章相关配置合集。
582582

583-
### 打赏 Reward
583+
### 打赏
584584

585585
开启后,将在每篇文章 `post` 末尾显示打赏按钮。
586586

@@ -798,7 +798,7 @@ error_img:
798798

799799
:::
800800

801-
## 其他配置 Other
801+
## 其他配置
802802

803803
这里是一些关于页面中杂项配置合集。
804804

@@ -848,7 +848,7 @@ rightside:
848848

849849
:::
850850

851-
### 日期格式化 Date Format
851+
### 日期格式化
852852

853853
用于配置主题中使用日期的格式。
854854

@@ -881,7 +881,7 @@ datetime_foramt:
881881

882882
:::
883883

884-
### 代码高亮 Highlight
884+
### 代码高亮
885885

886886
代码块中的所有功能只适用于 Hexo 自带的代码渲染,如果使用第三方的渲染器,不一定会有效
887887

@@ -948,7 +948,7 @@ highlight:
948948
theme: false
949949
```
950950

951-
## 自定义图标 Icon
951+
## 自定义图标
952952

953953
博客中存在一些固定的图标,譬如主题切换图标、分类图标等。
954954

@@ -994,7 +994,7 @@ icons:
994994
<link rel="stylesheet" href="/font-awesome.min.css">
995995
<icon-list title="主题使用图标预览" prefix="" :icons="themeIcons"></icon-list>
996996

997-
## 自定义样式 Style
997+
## 自定义样式
998998

999999
相比 `head` 引入,您可以直接编写 `less` 文件,并使用主题已有的变量,且将和主题样式文件一起编译。
10001000

@@ -1079,7 +1079,7 @@ icons:
10791079
@primary-weak: #7a89df;
10801080
```
10811081

1082-
## 自定义模板 Layout
1082+
## 自定义模板
10831083

10841084
主题允许您自定义模板来替换主题模板,此功能需要您的版本 v2.0.0+ 。
10851085

@@ -1127,7 +1127,7 @@ layout:
11271127
比如使用 pug ,您只需要安装 `hexo-render-pug` 后即可使用。
11281128
:::
11291129

1130-
## 渐进式应用 PWA
1130+
## 渐进式应用
11311131

11321132
开始 PWA 只需要设置 sw 为 true 即可,本主题已添加 Server Worker 相关操作 。
11331133

docs/guide/index.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121

2222
开始前,请确保您的 Hexo 初始化工作已经准备完成,请参考 [Hexo 安装](https://hexo.io/zh-cn/docs/)。本主题依赖于 **Node 14.x** 以上版本,请注意您本地 **Node** 环境。
2323

24-
## 快速开始 Get started
24+
## 快速开始
2525

2626
::: warning 渲染器
2727
如果您没有 `ejs``less` 的渲染器,请先安装:
@@ -38,7 +38,7 @@ npm install --save hexo-renderer-less hexo-renderer-ejs
3838
yarn add -D hexo-renderer-less hexo-renderer-ejs
3939
```
4040

41-
## 安装主题 Install
41+
## 安装主题
4242

4343
- 通过 npm 安装 (推荐)
4444

@@ -96,7 +96,7 @@ npm i hexo-theme-async@beta
9696
预览版本仅在主版本更新时使用,预览版还处于功能开发和 bug 修复阶段。如果您想提前尝试新功能,可以安装它,顺便能帮忙找找 Bug 🤣
9797
:::
9898

99-
## 启用主题 Use
99+
## 启用主题
100100

101101
修改 Hexo 站点配置文件 `_config.yml`
102102

@@ -105,7 +105,7 @@ npm i hexo-theme-async@beta
105105
theme: async
106106
```
107107
108-
## 配置主题 Config
108+
## 配置主题
109109
110110
在 Hexo 工作目录下新建 `_config.async.yml`( Hexo 5.0.0 + 起提供),您仅需在 `_config.async.yml` 中自定义您想要覆盖的配置,其余将自动与主题默认配置合并。
111111

@@ -134,7 +134,7 @@ theme:
134134

135135
更多主题配置 [请看这里](./config)
136136

137-
## 代码示例 Demo Code
137+
## 代码示例
138138

139139
自定义个性化修改示例
140140

@@ -147,7 +147,7 @@ theme:
147147
- [集成 Aplayer 播放器示例](https://stackblitz.com/edit/node-84g1dz?file=README.md)
148148

149149

150-
## 安装演示视频 Demo Video
150+
## 安装演示视频
151151

152152
- 安装
153153
- [npm 安装演示](https://www.bilibili.com/video/BV1Cs4y1J7vv/)

0 commit comments

Comments
 (0)