更新rules

CrychicTeam · Sep 21, 2024 · 17e2217 · 17e2217
1 parent 60fc5da
commit 17e2217
Show file tree

Hide file tree

Showing 2 changed files with 48 additions and 38 deletions.
diff --git a/docs/zh/doc/rules.md b/docs/zh/doc/rules.md
@@ -100,6 +100,53 @@ description: 该文章提供了本站文档编写规范！
 
 文档有一些内置的`插件/组件`，一般是为服务某种特殊场景而添加，可在[此处](./samples.md)查看，
 
+### 文档配置 {#doc-config}
+
+该文档文件都有以下[frontmatter](#frontmatter)配置字段。
+
+::: tip 提示
+
+本站同时支持Vitepress的原生frontmatter样式，详情请见[此处](https://vitepress.dev/zh/reference/frontmatter-config)
+
+:::
+
+| 配置字段      | 用途                             | 类型      | 省缺值     |
+|-----------|--------------------------------|---------|---------|
+| `title`   | 设置侧边栏中显示的标题（如未设置则使用文件名）        | string  | `N/A`   |
+| `noguide`| 该文章是否显示在侧边栏|boolean |`true`|
+|`backPath`|设置该界面点击BackButton后前往的位置|string|`N/A`|
+| `authors`  | 设置该文章额外的作者，显示在贡献者栏，配置可参考[此处](https://nolebase-integrations.ayaka.io/pages/zh-CN/integrations/vitepress-plugin-git-changelog/configure-vite-plugins#%E9%80%89%E9%A1%B9-mapcontributors-%E4%B8%BA%E8%B4%A1%E7%8C%AE%E8%80%85%E6%B7%BB%E5%8A%A0%E6%95%B0%E6%8D%AE%E6%98%A0%E5%B0%84)| string[]  | `N/A`   |
+| `showComment`  | 是否显示评论区 | boolean  | `true`   |
+| `gitChangelog`  | 是否显示贡献者和页面历史 | boolean  | `true`   |
+| `progress`  | 设置该文章的编撰进度 | int  | `N/A`   |
+| `description`  | 设置该文章的预览内容 | string  | `N/A`   |
+
+::: details 示例
+
+```yaml
+---
+title: 示例
+backPath: ../
+authors: ['M1hono', 'skyraah'] # 可在common-config中额外配置 但还是请尽量使用Github ID。
+showComment: false
+gitChangelog: false
+progress: 100
+description: 该文章提供了本站文档编写规范！
+---
+```
+
+:::
+
+#### frontmatter声明 {#frontmatter}
+
+在每个 Markdown 文件的开头，使用 `---` 来创建frontmatter配置
+
+```yaml
+---
+# 在这里添加您的frontmatter
+---
+```
+
 ### 类型补全 {#TwoSlash}
 
 该部分实际算Plugin的范畴，但其过于特殊。

diff --git a/docs/zh/doc/sidebarTutorial.md b/docs/zh/doc/sidebarTutorial.md
@@ -64,36 +64,9 @@ function logger(string: string, name: string): void {
 
 ### 文件扫描 {#file-scan}
 
-目标目录的文件将会自动被生成器扫描，并生成相应的侧边栏，每个文件都有以下[frontmatter](#frontmatter)配置字段。
+目标目录的文件将会自动被生成器扫描，并生成相应的侧边栏，每个文件的frontmatter配置字段详见[此处](./rules.md#doc-config)。
 
-::: tip 提示
-
-本站同时支持Vitepress的原生frontmatter样式，详情请见[此处](https://vitepress.dev/zh/reference/frontmatter-config)
-
-:::
-
-| 配置字段      | 用途                             | 类型      | 省缺值     |
-|-----------|--------------------------------|---------|---------|
-| `title`   | 设置侧边栏中显示的标题（如未设置则使用文件名）        | string  | `N/A`   |
-| `noguide`| 该文章是否显示在侧边栏|boolean |`true`|
-|`backPath`|设置该界面点击BackButton后前往的位置|string|`N/A`|
-| `authors`  | 设置该文章额外的作者，显示在贡献者栏，配置可参考[此处](https://nolebase-integrations.ayaka.io/pages/zh-CN/integrations/vitepress-plugin-git-changelog/configure-vite-plugins#%E9%80%89%E9%A1%B9-mapcontributors-%E4%B8%BA%E8%B4%A1%E7%8C%AE%E8%80%85%E6%B7%BB%E5%8A%A0%E6%95%B0%E6%8D%AE%E6%98%A0%E5%B0%84)| string[]  | `N/A`   |
-| `showComment`  | 是否显示评论区 | boolean  | `true`   |
-| `gitChangelog`  | 是否显示贡献者和页面历史 | boolean  | `true`   |
-
-::: details 示例
-
-```yaml
----
-title: 示例
-backPath: ../
-authors: ['M1hono', 'skyraah'] # 可在common-config中额外配置 但还是请尽量使用Github ID。
-showComment: false
-gitChangelog: false
----
-```
 
-:::
 
 ### 目录扫描 {#dir-scan}
 
@@ -189,16 +162,6 @@ root:
 
 :::
 
-## frontmatter声明 {#frontmatter}
-
-在每个 Markdown 文件的开头，使用 `---` 来创建frontmatter配置
-
-```yaml
----
-# 在这里添加您的frontmatter
----
-```
-
 <!-- ## 基本配置
 
 在每个 Markdown 文件的开头，使用 `---` 来分隔前置配置部分：