From 1f400a9317aec2728d8c81f4fc3d8077841c4507 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=B5=AE=E5=BF=83=E7=89=A9=E8=AF=AD?= <108316419+wuhang2003@users.noreply.github.com> Date: Sun, 31 Mar 2024 17:18:59 +0800 Subject: [PATCH] docs: update shiro config footer part (#60) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * docs: update shiro config footer part Signed-off-by: 浮心物语 <108316419+wuhang2003@users.noreply.github.com> * Update _meta.json Signed-off-by: 浮心物语 <108316419+wuhang2003@users.noreply.github.com> --------- Signed-off-by: 浮心物语 <108316419+wuhang2003@users.noreply.github.com> --- pages/themes/shiro/_meta.json | 5 +++-- pages/themes/shiro/config.mdx | 33 ++++++++++++++++++++++++++++++--- 2 files changed, 33 insertions(+), 5 deletions(-) diff --git a/pages/themes/shiro/_meta.json b/pages/themes/shiro/_meta.json index eb77e847..47e55513 100644 --- a/pages/themes/shiro/_meta.json +++ b/pages/themes/shiro/_meta.json @@ -1,4 +1,5 @@ { "index": "部署主题", - "extra": "额外功能" -} \ No newline at end of file + "extra": "额外功能", + "config": "配置项" +} diff --git a/pages/themes/shiro/config.mdx b/pages/themes/shiro/config.mdx index acbd7599..31909921 100644 --- a/pages/themes/shiro/config.mdx +++ b/pages/themes/shiro/config.mdx @@ -1,6 +1,33 @@ # 配置项 -## 站点信息 (`site`) +## 页脚信息(`footer`) + +此部分定义页脚的部分信息,主要包括备案、建站年份和页脚导航三部分。 + +### 备案(`otherInfo.icp`) + +此部分未在默认配置中提供。以下为参照写法: + +```json +"icp": { + "text": "浙ICP备20028356号", + "link": "https://beian.miit.gov.cn" + } +``` + +**如何使用**: 根据参照写法,修改位于 `text` 的备案号以及备案号所指向的链接 `link`。 + +### 建站年份(`otherInfo.date`) + +**如何使用**: `{{now}}` 指向当前年份,其他略。 + +### 页脚导航(`linkSections`) + +分类包括 `name` 和 `links` 两个字段,对应分类名字及其下链接,其下链接又分为 `name`、`href`、`external` 三个字段,对应链接名字,指向链接和是否外链三个属性。 + +**如何使用**: 根据自己需要增删或修改特定链接及分类,需要注意如果指向外链的话需要加一行 `"external": true`。 + +## 站点信息 (`config.site`) 此部分包含了网站的基础信息设置,例如 favicon(网站图标)的配置。 @@ -9,7 +36,7 @@ - **`favicon`**: 设置网站在浅色模式下使用的图标。 - **`faviconDark`**: 设置网站在深色模式下使用的图标。 -## Hero 部分 (`hero`) +## Hero 部分 (`config.hero`) `hero` 部分定义了网站首页的主要欢迎信息或介绍部分,这是访问者首次进入网站时看到的部分。 @@ -25,7 +52,7 @@ **如何使用**: 直接修改 `description` 的值以更改介绍文本。 -## 模块 (`module`) +## 模块 (`config.module`) 此部分配置了网站的一些特定功能模块,比如活动跟踪、捐赠支持、社交媒体链接等。