Skip to content
This repository has been archived by the owner on Jan 15, 2025. It is now read-only.

Commit

Permalink
docs: 更新文档
Browse files Browse the repository at this point in the history
  • Loading branch information
zkz098 committed Feb 15, 2024
1 parent b4ad657 commit 23b3c7a
Show file tree
Hide file tree
Showing 6 changed files with 794 additions and 1,506 deletions.
Binary file removed docs/guide/perf-1.webp
Binary file not shown.
1 change: 1 addition & 0 deletions docs/guide/perf1.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
31 changes: 23 additions & 8 deletions docs/guide/performance.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,23 @@
下方数据均基于 lighthouse 移动设备规格测试
:::
针对预览网站和 shoka 的实地测试: \
![性能报告](perf-1.webp)
![性能报告](perf1.svg)
附源数据:

- 请注意,由于各预览网站间的差异(CDN、shokaX 版本、第三方 js),实地测试**并不能**反应 ShokaX 实际部署时的性能,只是一个参考数据
| 预览网站 | FCP | LCP | SI | ShokaX 版本 |
|:--------:|:----:|:-----:|:----:|:---------:|
| zkz098 | 1.7s | 3.3s | 4.1s | 0.4.2 |
| d-sketon | 1.4s | 3.6s | 3.1s | 0.4.2 |
| joytion | 2.6s | 4.7s | 4.3s | 0.3.12 |
| shoka | 3.2s | 24.2s | 5.5s | shoka |

针对长文章(字数 50k+)的实验室数据: \
![性能报告](perf-2.webp)
测试环境:

- ShokaX-LPO 指开启长文章优化的 ShokaX v0.2.9
- 受制于第三方因素(例如`hexo s`无文本压缩),此数据无法准确反应生产环境下的 ShokaX 长文章性能,仅供参考
- Microsoft Edge 122
- 国内网络环境
- Lighthouse 移动设备规格

请注意,由于各预览网站间的差异(CDN、shokaX 版本、第三方 js),实地测试**并不能**反应 ShokaX 实际部署时的性能,只是一个参考数据

## 优化网页

Expand All @@ -37,9 +45,16 @@ Shoka 系主题的图片都是性能影响的最大因素,可通过如下方
平均每个插件会让 FCP 增加 0.1-0.3 秒并让 SI 增加 0.3-0.8 秒,尤其是 qweather 类插件
会发起大量的 HTTP 请求并拖慢加载速度。

### 自编译 typescript 和调整压缩配置
### 适当调整图片大小

假如你准备使用 fixedCover,参照如下规格配置图片:

- 所有图片采用 webp 格式,且采用压缩方法 6
- `_images.yml` 中的图片使用宽不大于420px的图片,质量建议为 70-80
- `fixedCover` 使用宽不大于1280px的图片,质量建议为 85-95
- 作者头像使用 160px 1:1 的图片,质量建议为 75-85

ShokaX 稳定版提供了预编译的 javascript ES2022 版本,如果你的站点需要 ES6 兼容或希望拥有更高的性能,请参考二次开发或 typescript 官方文档自编译 ts \
如果不使用 fixedCover,`_images.yml`均需要不大于1280px(不建议小于900px)的图片

### 关闭不使用的功能

Expand Down
49 changes: 42 additions & 7 deletions docs/guide/theme.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,20 +15,17 @@ css: "css" # css 存放目录 (不建议改动)
js: "js" # js 存放目录 (不建议改动)
```
#### 自定义网站图片
### 自定义网站图片
::: tip
:::: tip
以下文件的修改均在 `/source/_data/` 中预设的素材文件夹中进行,如 `/source/_data/assets`
:::details 详细步骤

- 在 Hexo 的根目录 `/source` 文件夹下;
- 进入 `/_data` 目录(如果没有则创建);
- 根据 `/_config.shokax.yml` 或 `/_config.shokaX.yml` 中自定义的图片目录(如 `assets` ),在 `_data` 目录下创建对应的目录。
:::

:::warning
现**仅支持**`*.jpg`,`*.png`,`*.ico`的**静态文件**解析
:::
::::

- 不同的文件名称分别代表对应的图片。
- `avatar.jpg` 默认情况下对应主页上的个人头像,可修改
Expand All @@ -40,6 +37,42 @@ js: "js" # js 存放目录 (不建议改动)
- `paypal.png` PayPal 捐赠收款码
- `search.png` 搜索下显示的图片

:::tips
大多数文件名可调,建议尽可能地将 png、jpg 替换为 webp 或 avif 以提高性能
:::

### 功能模块

此处指示 ShokaX 功能模块是否开启,在不使用的情况下建议关闭对应模块

```yaml
modules:
player: true # 启用音乐播放器
fireworks: true # 启用鼠标点击烟花特效
unlazyHash: false # 启用unlazy hash预览图支持
visibilityListener: true # 启用可见度监听器
tabs: true # 启用选项卡扩展支持,如需开启 summary 功能请一并开启
quiz: true # 启用文章内问题扩展支持
fancybox: true # 启用 fancybox 支持(不建议禁用)
```

部分配置的解释:

- 如果需要使用 media tag,请开启 player 模块
- 如果不喜欢切换标签页改变标题这个功能,请关闭 visibilityListener

### 主页配置

```yaml
homeConfig:
gradient: false # 使用CSS渐变作为文章封面
# fixedCover 性能比默认的更好,且开启时将启用LCP优化和预加载
fixedCover: "" # 主页面cover(为空则使用bing随机图片)
```

当 gradient 启用时,将使用渐变色封面代替`_images.yml`,渐变色集不可控制
当 fixedCover 启用时,上方的图片轮播集将被锁定为 fixedCover 配置的图片,`_images.yml`不再控制头图

## Iconfont图标、导航栏、社交链接、侧边栏、大标题

### Iconfont图标
Expand Down Expand Up @@ -240,6 +273,7 @@ performance:
`preConnect` 选项会对链接进行预连接,这会极大加速 CDN 文件/评论系统的加载速度,但使用过多会影响首屏性能。

`dnsPrefetch` 适用于“不值得使用 `pre-connect`”的,此模式仅会优化 DNS 解析,适用于部分非关键站外链接(例如广告和站外视频)。
:::

## SEO 优化和访客优化

Expand Down Expand Up @@ -286,7 +320,7 @@ auto_scroll: false

### 网站标题自定义

::: tip
:::: tip
自动网站点击之后和隐藏之后的标题,可覆盖原本呈现的文字。
以下配置均在 `/_source/_data/languages.yml` 文件中修改。
:::details 详细步骤
Expand All @@ -296,6 +330,7 @@ auto_scroll: false
- 在下面创建文件 `languages.yml`;
- 修改网站标题在不同语言情况下 favicon show 时,和隐藏呈现的文字。
:::
::::

```yaml
# language
Expand Down
16 changes: 8 additions & 8 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,17 +13,17 @@
"author": "zkz098",
"license": "GPL-3.0-or-later",
"dependencies": {
"@algolia/client-search": "< 6",
"@vuepress/client": "2.0.0-rc.0",
"@vuepress/plugin-docsearch": "2.0.0-rc.0",
"@vuepress/plugin-google-analytics": "2.0.0-rc.0",
"@algolia/client-search": "^4.22.1",
"@vuepress/client": "2.0.0-rc.7",
"@vuepress/plugin-docsearch": "2.0.0-rc.12",
"@vuepress/plugin-google-analytics": "2.0.0-rc.12",
"algoliasearch": "^4.22.1",
"lightningcss": "^1.23.0",
"sass": "^1.70.0",
"typescript": "^5.3.3",
"vue": "^3.4.15",
"vuepress": "2.0.0-rc.0",
"vuepress-plugin-pwa2": "2.0.0-rc.11",
"vuepress-theme-hope": "2.0.0-rc.11"
"vue": "^3.4.19",
"vuepress": "2.0.0-rc.7",
"vuepress-plugin-pwa2": "2.0.0-rc.23",
"vuepress-theme-hope": "2.0.0-rc.23"
}
}
Loading

0 comments on commit 23b3c7a

Please sign in to comment.