From 11c9993f83b6fc98f631d921b19bee4fce5e6ba3 Mon Sep 17 00:00:00 2001
From: "Mr.Hope" <mister-hope@outlook.com>
Date: Tue, 30 Jan 2024 21:58:00 +0800
Subject: [PATCH] docs: tweaks

---
 docs/plugins/feed/config.md         |  2 -
 docs/zh/plugins/feed/config.md      | 74 ++++++++++++++---------------
 docs/zh/plugins/feed/frontmatter.md | 24 +++++-----
 docs/zh/plugins/feed/getter.md      | 29 +++++------
 4 files changed, 61 insertions(+), 68 deletions(-)

diff --git a/docs/plugins/feed/config.md b/docs/plugins/feed/config.md
index 619d6c02b6..874985d7eb 100644
--- a/docs/plugins/feed/config.md
+++ b/docs/plugins/feed/config.md
@@ -52,7 +52,6 @@ If your site has a lot of articles, you may consider this option to reduce feed
 ## preservedElements
 
 - Type: `(RegExp | string)[] | (tagName: string) => boolean`
-- Default: `[]`
 
 Custom element or component which should be preserved in feed.
 
@@ -192,7 +191,6 @@ Feed generation controller, see [Feed Getter](./getter.md).
 ## locales
 
 - Type: `Record<string, BaseFeedOptions>`
-- Required: No
 
 You can use it to specific options for each locale.
 
diff --git a/docs/zh/plugins/feed/config.md b/docs/zh/plugins/feed/config.md
index dfb146b579..ab9b02bb1e 100644
--- a/docs/zh/plugins/feed/config.md
+++ b/docs/zh/plugins/feed/config.md
@@ -2,48 +2,48 @@
 
 ## hostname
 
-- 类型: `string`
-- 必填: 是
+- 类型：`string`
+- 必填：是
 
 部署网站的域名。
 
 ## atom
 
-- 类型: `boolean`
-- 默认值: `false`
+- 类型：`boolean`
+- 默认值：`false`
 
 是否启用 Atom 格式输出。
 
 ## json
 
-- 类型: `boolean`
-- 默认值: `false`
+- 类型：`boolean`
+- 默认值：`false`
 
 是否启用 JSON 格式输出。
 
 ## rss
 
-- 类型: `boolean`
-- 默认值: `false`
+- 类型：`boolean`
+- 默认值：`false`
 
 是否启用 RSS 格式输出。
 
 ## image
 
-- 类型: `string`
+- 类型：`string`
 
 一个大的图片，用作 feed 展示。
 
 ## icon
 
-- 类型: `string`
+- 类型：`string`
 
 一个小的图标，显示在订阅列表中。
 
 ## count
 
-- 类型: `number`
-- 默认值: `100`
+- 类型：`number`
+- 默认值：`100`
 
 设置 feed 的最大项目数量。在所有页面排序好后，插件会截取前 count 个项目。
 
@@ -51,8 +51,7 @@
 
 ## preservedElements
 
-- 类型: `(RegExp | string)[] | (tagName: string) => boolean`
-- 默认值: `[]`
+- 类型：`(RegExp | string)[] | (tagName：string) => boolean`
 
 应在 Feed 中保留的自定义元素或组件。
 
@@ -62,8 +61,8 @@
 
 ## filter
 
-- 类型: `(page: Page)=> boolean`
-- 默认值:
+- 类型：`(page: Page)=> boolean`
+- 默认值：
 
   ```ts
   ({ frontmatter, filePathRelative }: Page): boolean =>
@@ -79,9 +78,9 @@
 
 ## sorter
 
-- 类型: `(pageA: Page, pageB: Page)=> number`
+- 类型： `(pageA: Page, pageB: Page)=> number`
 
-- 默认值:
+- 默认值：
 
   ```ts
   // compareDate 来源于 vuepress-shared
@@ -114,8 +113,8 @@ Feed 项目的排序器。
 
 ## devServer
 
-- 类型: `boolean`
-- 默认值: `false`
+- 类型：`boolean`
+- 默认值：`false`
 
 是否在开发服务器中启用
 
@@ -127,57 +126,57 @@ Feed 项目的排序器。
 
 ## devHostname
 
-- 类型: `string`
-- 默认值: `"http://localhost:${port}"`
+- 类型：`string`
+- 默认值：`"http://localhost:${port}"`
 
 开发服务器使用的主机名
 
 ## atomOutputFilename
 
-- 类型: `string`
-- 默认值: `"atom.xml"`
+- 类型：`string`
+- 默认值：`"atom.xml"`
 
 Atom 格式输出路径，相对于输出路径。
 
 ## atomXslTemplate
 
-- 类型: `string`
-- 默认值: `@vuepress/plugin-feed/templates/atom.xsl` 的内容
+- 类型：`string`
+- 默认值：`@vuepress/plugin-feed/templates/atom.xsl` 的内容
 
 Atom xsl 模板文件没人陪美国
 
 ## atomXslFilename
 
-- 类型: `string`
-- 默认值: `"atom.xsl"`
+- 类型：`string`
+- 默认值：`"atom.xsl"`
 
 Atom xsl 输出路径，相对于输出路径。
 
 ## jsonOutputFilename
 
-- 类型: `string`
-- 默认值: `"feed.json"`
+- 类型：`string`
+- 默认值：`"feed.json"`
 
 JSON 格式输出路径，相对于输出路径。
 
 ## rssOutputFilename
 
-- 类型: `string`
-- 默认值: `"rss.xml"`
+- 类型：`string`
+- 默认值：`"rss.xml"`
 
 RSS 格式输出路径，相对于输出路径。
 
 ## rssXslTemplate
 
-- 类型: `string`
-- 默认值: `@vuepress/plugin-feed/templates/rss.xsl` 的内容
+- 类型：`string`
+- 默认值：`@vuepress/plugin-feed/templates/rss.xsl` 的内容
 
 RSS xsl 模板文件内容。
 
 ## rssXslFilename
 
-- 类型: `string`
-- 默认值: `"rss.xsl"`
+- 类型：`string`
+- 默认值：`"rss.xsl"`
 
 RSS xsl 输出路径，相对于输出路径。
 
@@ -191,8 +190,7 @@ Feed 生成控制器，详见 [Feed 生成器](./getter.md)。
 
 ## locales
 
-- 类型: `Record<string, BaseFeedOptions>`
-- 必填: 否
+- 类型：`Record<string, BaseFeedOptions>`
 
 你可以将它用于每个语言环境的特定选项。
 
diff --git a/docs/zh/plugins/feed/frontmatter.md b/docs/zh/plugins/feed/frontmatter.md
index 07bb397e0d..930a80ab54 100644
--- a/docs/zh/plugins/feed/frontmatter.md
+++ b/docs/zh/plugins/feed/frontmatter.md
@@ -10,25 +10,25 @@
 
 ### title
 
-- 类型: `string`
+- 类型：`string`
 
 由 VuePress 自动生成，默认为页面的 h1 内容
 
 ### description
 
-- 类型: `string`
+- 类型：`string`
 
 页面描述
 
 ### date
 
-- 类型: `Date`
+- 类型：`Date`
 
 页面的发布日期
 
 ### article
 
-- 类型: `boolean`
+- 类型：`boolean`
 
 该页面是否是文章
 
@@ -36,13 +36,13 @@
 
 ### copyright
 
-- 类型: `string`
+- 类型：`string`
 
 页面版权信息
 
 ### cover / image / banner
 
-- 类型: `string`
+- 类型：`string`
 
 页面的封面/分享图，需为完整链接或绝对链接。
 
@@ -50,25 +50,25 @@
 
 ### feed.title
 
-- 类型: `string`
+- 类型：`string`
 
 Feed 项目的标题
 
 ### feed.description
 
-- 类型: `string`
+- 类型：`string`
 
 Feed 项目的描述
 
 ### feed.content
 
-- 类型: `string`
+- 类型：`string`
 
 Feed 项目的内容
 
 ### feed.author
 
-- 类型: `FeedAuthor[] | FeedAuthor`
+- 类型：`FeedAuthor[] | FeedAuthor`
 
 Feed 项目的作者
 
@@ -106,7 +106,7 @@ interface FeedAuthor {
 
 ### feed.contributor
 
-- 类型: `FeedContributor[] | FeedContributor`
+- 类型：`FeedContributor[] | FeedContributor`
 
 Feed 项目的贡献者
 
@@ -144,7 +144,7 @@ interface FeedContributor {
 
 ### feed.guid
 
-- 类型: `string`
+- 类型：`string`
 
 Feed 项目的标识符，用于标识 Feed 项目。
 
diff --git a/docs/zh/plugins/feed/getter.md b/docs/zh/plugins/feed/getter.md
index 514df48fff..37d7bc5bc5 100644
--- a/docs/zh/plugins/feed/getter.md
+++ b/docs/zh/plugins/feed/getter.md
@@ -1,25 +1,22 @@
----
-title: Feed 获取器
-icon: shapes
----
+# Feed 获取器
 
 你可以通过控制插件选项中的 `getter` 来完全控制 Feed 项目的生成。
 
 ## getter.title
 
-- 类型: `(page: Page) => string`
+- 类型：`(page: Page) => string`
 
 项目标题获取器
 
 ## getter.link
 
-- 类型: `(page: Page) => string`
+- 类型：`(page: Page) => string`
 
 项目链接获取器
 
 ## getter.description
 
-- 类型: `(page: Page) => string | undefined`
+- 类型：`(page: Page) => string | undefined`
 
 项目描述获取器
 
@@ -31,13 +28,13 @@ icon: shapes
 
 ## getter.content
 
-- 类型: `(page: Page) => string`
+- 类型：`(page: Page) => string`
 
 项目内容获取器
 
 ## getter.author
 
-- 类型: `(page: Page) => FeedAuthor[]`
+- 类型：`(page: Page) => FeedAuthor[]`
 
 项目作者获取器。
 
@@ -79,7 +76,7 @@ interface FeedAuthor {
 
 ## getter.category
 
-- 类型: `(page: Page) => FeedCategory[] | undefined`
+- 类型：`(page: Page) => FeedCategory[] | undefined`
 
 项目分类获取器。
 
@@ -112,7 +109,7 @@ interface FeedCategory {
 
 ## getter.enclosure
 
-- 类型: `(page: Page) => FeedEnclosure | undefined`
+- 类型：`(page: Page) => FeedEnclosure | undefined`
 
 项目附件获取器。
 
@@ -145,19 +142,19 @@ interface FeedEnclosure {
 
 ## getter.publishDate
 
-- 类型: `(page: Page) => Date | undefined`
+- 类型：`(page: Page) => Date | undefined`
 
 项目发布日期获取器
 
 ## getter.lastUpdateDate
 
-- 类型: `(page: Page) => Date`
+- 类型：`(page: Page) => Date`
 
 项目最后更新日期获取器
 
 ## getter.image
 
-- 类型: `(page: Page) => string`
+- 类型：`(page: Page) => string`
 
 项目图片获取器
 
@@ -167,7 +164,7 @@ interface FeedEnclosure {
 
 ## getter.contributor
 
-- 类型: `(page: Page) => FeedContributor[]`
+- 类型：`(page: Page) => FeedContributor[]`
 
 项目贡献者获取器
 
@@ -209,6 +206,6 @@ interface FeedContributor {
 
 ## getter.copyright
 
-- 类型: `(page: Page) => string | undefined`
+- 类型：`(page: Page) => string | undefined`
 
 项目版权获取器