Skip to content

Commit

Permalink
📃 docs: 文档更新
Browse files Browse the repository at this point in the history
  • Loading branch information
白云苍狗 committed Mar 31, 2023
1 parent 914a527 commit fdfbfd9
Show file tree
Hide file tree
Showing 6 changed files with 70 additions and 10 deletions.
14 changes: 14 additions & 0 deletions docs/.vitepress/assets/log.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,20 @@
{
"large_version": "v2.0.x",
"children": [
{
"version": "2.0.5",
"date": "2023-03-31",
"logs": [
{
"type": "fix",
"text": "修复移动端出现横向滚动"
},
{
"type": "perf",
"text": "优化本地搜索样式"
}
]
},
{
"version": "2.0.4",
"date": "2023-03-20",
Expand Down
4 changes: 2 additions & 2 deletions docs/.vitepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,11 @@ export default defineConfig({

themeConfig: {
logo: "/logo.svg",
algolia: {
/* algolia: {
appId: "GER60TPC08",
apiKey: "993137f59d71d252c8bafbce33bda9c2",
indexName: "hexo_theme_async_docs",
},
}, */
editLink: {
pattern: "https://github.com/Maluns/hexo-theme-async/edit/master/docs/:path",
text: "帮助改善此页面!(  ̄□ ̄)/",
Expand Down
22 changes: 19 additions & 3 deletions docs/guide/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -197,7 +197,7 @@ assets:
::: warning
当您覆盖内置图标资源时,因为博客 UI 中一些固定的图标使用到了,所以您需要将 [固定图标](#自定义图标-icon) 进行修改。

单色图标 和 多色图标是可以同时使用的,但是博客 UI 固定图标只能根据 `type` 决定使用哪一种。
单色图标 和 多色图标是可以同时使用的,但是博客 UI 的**固定图标**只能根据 `type` 决定使用哪一种。
:::

## 用户信息 User
Expand Down Expand Up @@ -333,6 +333,22 @@ banner:

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

页脚所有配置预览:
```yaml
footer:
powered:
enable: true
beian:
enable: false
icp:
copyrightYear:
live_time:
enable: false
prefix: footer.tips
start_time: 04/10/2022 17:00:00
custom_text:
```

### 起始年份

```yaml
Expand Down Expand Up @@ -763,8 +779,8 @@ icons:

### `1.1.x` 版本

- 新建 `source/_data/style/dark.less`、`source/_data/style/light.less`,开始编写你的自定义样式了。他们分别默认会合并到 `dark`、`light` 两种模式中去。
- 如果需要覆盖变量可以添加 `source/_data/style/dark.variables.less`、`source/_data/style/light.variables.less`,进行覆盖。
- 新建 **source/_data/style/dark.less**、**source/_data/style/light.less**,开始编写你的自定义样式了。他们分别默认会合并到 `dark`、`light` 两种模式中去。
- 如果需要覆盖变量可以添加 **source/_data/style/dark.variables.less**、**source/_data/style/light.variables.less**,进行覆盖。

```text {4,5,6,7,8}
┌── blog
Expand Down
27 changes: 22 additions & 5 deletions docs/guide/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

::: tip

- <Badge text="dev" vertical="middle"/> 代表只和开发有关。默认示例站点使用的 dev 分支,所以可能会出现还未发版功能。
- <Badge text="dev" vertical="middle"/> 代表只和开发有关。默认示例站点使用的 dev 分支,所以可能会出现还未发版功能。

:::

Expand All @@ -26,9 +26,9 @@ root: /
检查是否在 `_config.async.yml` 文件中进行主题配置,且已经保存。
检查是否已经执行如下几步:

- `hexo clean`:清除本地缓存
- `hexo g`:生成新的静态文件
- `hexo s`:本地查看效果(如果正常,使用 `hexo d` 重新部署)
- `hexo clean`:清除本地缓存
- `hexo g`:生成新的静态文件
- `hexo s`:本地查看效果(如果正常,使用 `hexo d` 重新部署)

检查是否已强制刷新本地浏览器缓存(Windows: `Ctrl + F5`,Mac: `Shift + Cmd + R`)。

Expand All @@ -37,9 +37,26 @@ root: /
主题相关问题请发起 [ISSUE](https://github.com/MaLuns/hexo-theme-async/issues) ,其他讨论与展示请使用 [Discussions](https://github.com/MaLuns/hexo-theme-async/discussions)。

## 配置项不生效?

你可以参考查看 [\_config.yml | hexo-theme-async](https://github.com/MaLuns/hexo-theme-async/blob/master/package/hexo-theme-async/_config.yml) 文件及相关注释,确保你配置正确性。

- 初始安装后不生效?

检查配置文件路径、文件名是否正确,然后检查配置文档是否正确。

- 版本升级后配置不生效?

检查安装主题版本,然后查看更新日志里是否发生变更,参考文档配置说明,确保配置正确。

## 运行出现如下错误

如图:
![示例](/imgs/node.png)

说明您 Node 版本低于 14.x,请升级你的 Node 版本。

## About 页面不显示?

检查是否和其他插件冲突,解决方式,可以弃用配置方式,在 md 文件里编写您的 About 页面。

## 页面加载缓慢?或者页面显示不完整,无法滚动等。
Expand All @@ -48,4 +65,4 @@ root: /

![示例](/imgs/cdn_err.png)

打开控制面板,检查插件是否加载正确加载,因为 jsdelivr、unpkg 国内可以会出现 DNS 污染等原因,导致有时候可能无法使用,可以参考[这里](https://hexo-theme-async.imalun.com/guide/config.html#%E6%8F%92%E4%BB%B6-plugins)替换 CDN 源。
打开控制面板,检查插件是否加载正确加载,因为 jsdelivr、unpkg 国内可以会出现 DNS 污染等原因,导致有时候可能无法使用,可以参考[这里](https://hexo-theme-async.imalun.com/guide/config.html#%E6%8F%92%E4%BB%B6-plugins)替换 CDN 源。
13 changes: 13 additions & 0 deletions docs/guide/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,19 @@

也可前往 [QQ 群](https://jq.qq.com/?_wv=1027&k=0hEe5D0U),进行反馈。

::: danger 提醒

- 安装问题

本插件只是 Hexo 主题,如果你想使用这款主题模板,请确保你对 Hexo 有一些基本了解。关于 Hexo 初始化不成功、Npm 安装失败等问题,一般与主题无关,请自行检查自己网络环境,合理利用搜索引擎自行解决。

- 配置问题

**本文档已经覆盖了,本主题使用的 99% 配置**。请不要上来无脑问 xxxx 怎么配置,**请优先翻阅文档**,参考文档里的说明。如果使用中发现文档中有解释存在歧义地方,可以通过上面多种渠道进行反馈,也可以提交 PR 进行完善。
:::

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

## 快速开始 Get started

::: warning 渲染器
Expand Down
Binary file added docs/public/imgs/node.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit fdfbfd9

Please sign in to comment.