Skip to content
This repository was archived by the owner on Nov 2, 2024. It is now read-only.

Commit 853026f

Browse files
committed
feat: config docs
Signed-off-by: Innei <[email protected]>
1 parent bf206e3 commit 853026f

File tree

2 files changed

+68
-1
lines changed

2 files changed

+68
-1
lines changed

pages/themes/shiro/config.mdx

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# 配置项
2+
3+
## 站点信息 (`site`)
4+
5+
此部分包含了网站的基础信息设置,例如 favicon(网站图标)的配置。
6+
7+
### Favicon
8+
9+
- **`favicon`**: 设置网站在浅色模式下使用的图标。
10+
- **`faviconDark`**: 设置网站在深色模式下使用的图标。
11+
12+
## Hero 部分 (`hero`)
13+
14+
`hero` 部分定义了网站首页的主要欢迎信息或介绍部分,这是访问者首次进入网站时看到的部分。
15+
16+
### Title 模板 (`title.template`)
17+
18+
包括多个元素(如 `h1`, `code`, `span`),每个元素都可以自定义文本内容和样式(通过 CSS 类)。
19+
20+
**如何使用**: 修改 `text``class` 字段来自定义标题的文本内容和样式。你可以通过添加或删除元素来调整标题的结构。
21+
22+
### 描述 (`description`)
23+
24+
提供了对 `hero` 部分的简短描述。
25+
26+
**如何使用**: 直接修改 `description` 的值以更改介绍文本。
27+
28+
## 模块 (`module`)
29+
30+
此部分配置了网站的一些特定功能模块,比如活动跟踪、捐赠支持、社交媒体链接等。
31+
32+
### 实时活动 (`activity`) 模块
33+
34+
- **`enable`**: 控制模块是否启用。
35+
- **`endpoint`**: 指定活动更新的服务器端点。
36+
37+
**如何使用**: 若需开启活动跟踪功能,将 `enable` 设为 `true` 并设置 `endpoint` 为处理活动数据的服务器地址。
38+
39+
### 捐赠 (`donate`) 模块
40+
41+
- **`enable`**: 控制捐赠模块是否启用。
42+
- **`link`**: 提供捐赠页面的链接。
43+
- **`qrcode`**: 提供一或多个捐赠二维码图片的链接。
44+
45+
**如何使用**: 启用捐赠功能,并提供捐赠链接或捐赠二维码,以便支持者可以直接进行捐赠。
46+
47+
### 社交媒体 (`bilibili`) 模块
48+
49+
- **`liveId`**: 指定社交媒体平台的直播或个人页面 ID。
50+
51+
**如何使用**: 配置 `liveId` 以链接到特定的社交媒体直播或个人页面。
52+
53+
import { ProTag } from '@components/Tag'
54+
55+
### [OpenPanel](https://openpanel.dev) <ProTag />
56+
57+
- **`enable`**: 控制 OpenPanel 功能是否启用。
58+
- **`id`**: OpenPanel 的 ID。
59+
- **`url`**: OpenPanel 的访问地址。
60+
61+
**如何使用**: 如果你使用 OpenPanel 提供交互式面板或其他功能,通过这些配置连接并显示面板。

pages/themes/shiro/index.mdx

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,13 @@ import Video from '@components/Video'
7777
- 数据:(点击下方的按钮复制)
7878

7979
<Callout>
80-
请注意,这份配置你需要自行修改成符合你的需求的配置。直接使用下面的配置可能会导致你的博客无法按照你的预期运行。
80+
<p>
81+
请注意,这份配置你需要自行修改成符合你的需求的配置。直接使用下面的配置可能会导致你的博客无法按照你的预期运行。
82+
</p>
83+
<p>
84+
下面的配置可能不全,更多配置项的信息请移步 [配置项](./shiro/config.mdx)
85+
阅读更多。
86+
</p>
8187
</Callout>
8288

8389
```json showLineNumbers

0 commit comments

Comments
 (0)