:::
-### blog
+### posts
-将 博客文章列表页 作为一个单独区域，插入到 首页中。
+将 post 集合文章列表页 作为一个单独区域，插入到 首页中。
+
+```ts
+interface PlumeThemeHomePosts extends PlumeHomeConfigBase {
+ type: 'posts'
+ collection?: string
+}
+```
+
+当存在多个 post 集合时，默认读取第一个集合的文章列表页。
+还可以通过 `collection` 配置项来指定读取哪个集合的文章列表页。
+
+`collection` 的值应该与 集合的 `dir` 值相同。
+
+**示例：**
+
+```md
+---
+home: true
+config:
+ -
+ type: posts
+ collection: blog
+---
+```
### profile
diff --git a/docs/notes/theme/guide/custom/slots.md b/docs/guide/custom/slots.md
similarity index 100%
rename from docs/notes/theme/guide/custom/slots.md
rename to docs/guide/custom/slots.md
diff --git a/docs/notes/theme/guide/custom/style.md b/docs/guide/custom/style.md
similarity index 100%
rename from docs/notes/theme/guide/custom/style.md
rename to docs/guide/custom/style.md
diff --git a/docs/notes/theme/guide/embed/acfun.md b/docs/guide/embed/acfun.md
similarity index 100%
rename from docs/notes/theme/guide/embed/acfun.md
rename to docs/guide/embed/acfun.md
diff --git a/docs/notes/theme/guide/embed/artplayer.md b/docs/guide/embed/artplayer.md
similarity index 100%
rename from docs/notes/theme/guide/embed/artplayer.md
rename to docs/guide/embed/artplayer.md
diff --git a/docs/notes/theme/guide/embed/audioReader.md b/docs/guide/embed/audioReader.md
similarity index 100%
rename from docs/notes/theme/guide/embed/audioReader.md
rename to docs/guide/embed/audioReader.md
diff --git a/docs/notes/theme/guide/embed/bilibili.md b/docs/guide/embed/bilibili.md
similarity index 100%
rename from docs/notes/theme/guide/embed/bilibili.md
rename to docs/guide/embed/bilibili.md
diff --git a/docs/notes/theme/guide/embed/pdf.md b/docs/guide/embed/pdf.md
similarity index 100%
rename from docs/notes/theme/guide/embed/pdf.md
rename to docs/guide/embed/pdf.md
diff --git a/docs/notes/theme/guide/embed/youtube.md b/docs/guide/embed/youtube.md
similarity index 100%
rename from docs/notes/theme/guide/embed/youtube.md
rename to docs/guide/embed/youtube.md
diff --git a/docs/notes/theme/guide/features/bulletin.md b/docs/guide/features/bulletin.md
similarity index 100%
rename from docs/notes/theme/guide/features/bulletin.md
rename to docs/guide/features/bulletin.md
diff --git a/docs/notes/theme/guide/features/changelog.md b/docs/guide/features/changelog.md
similarity index 100%
rename from docs/notes/theme/guide/features/changelog.md
rename to docs/guide/features/changelog.md
diff --git a/docs/notes/theme/guide/features/comments.md b/docs/guide/features/comments.md
similarity index 100%
rename from docs/notes/theme/guide/features/comments.md
rename to docs/guide/features/comments.md
diff --git a/docs/notes/theme/guide/features/component.md b/docs/guide/features/component.md
similarity index 100%
rename from docs/notes/theme/guide/features/component.md
rename to docs/guide/features/component.md
diff --git a/docs/notes/theme/guide/features/contributors.md b/docs/guide/features/contributors.md
similarity index 100%
rename from docs/notes/theme/guide/features/contributors.md
rename to docs/guide/features/contributors.md
diff --git a/docs/notes/theme/guide/features/copyright.md b/docs/guide/features/copyright.md
similarity index 100%
rename from docs/notes/theme/guide/features/copyright.md
rename to docs/guide/features/copyright.md
diff --git a/docs/notes/theme/guide/features/encryption.md b/docs/guide/features/encryption.md
similarity index 100%
rename from docs/notes/theme/guide/features/encryption.md
rename to docs/guide/features/encryption.md
diff --git a/docs/notes/theme/guide/features/friend-links.md b/docs/guide/features/friend-links.md
similarity index 100%
rename from docs/notes/theme/guide/features/friend-links.md
rename to docs/guide/features/friend-links.md
diff --git a/docs/notes/theme/guide/features/icon.md b/docs/guide/features/icon.md
similarity index 100%
rename from docs/notes/theme/guide/features/icon.md
rename to docs/guide/features/icon.md
diff --git a/docs/notes/theme/guide/features/image-preview.md b/docs/guide/features/image-preview.md
similarity index 100%
rename from docs/notes/theme/guide/features/image-preview.md
rename to docs/guide/features/image-preview.md
diff --git a/docs/notes/theme/guide/features/replace-assets.md b/docs/guide/features/replace-assets.md
similarity index 100%
rename from docs/notes/theme/guide/features/replace-assets.md
rename to docs/guide/features/replace-assets.md
diff --git a/docs/notes/theme/guide/features/search.md b/docs/guide/features/search.md
similarity index 100%
rename from docs/notes/theme/guide/features/search.md
rename to docs/guide/features/search.md
diff --git a/docs/notes/theme/guide/features/seo.md b/docs/guide/features/seo.md
similarity index 100%
rename from docs/notes/theme/guide/features/seo.md
rename to docs/guide/features/seo.md
diff --git a/docs/notes/theme/guide/features/sitemap.md b/docs/guide/features/sitemap.md
similarity index 100%
rename from docs/notes/theme/guide/features/sitemap.md
rename to docs/guide/features/sitemap.md
diff --git a/docs/notes/theme/guide/features/watermark.md b/docs/guide/features/watermark.md
similarity index 100%
rename from docs/notes/theme/guide/features/watermark.md
rename to docs/guide/features/watermark.md
diff --git a/docs/notes/theme/guide/markdown/abbr.md b/docs/guide/markdown/abbr.md
similarity index 100%
rename from docs/notes/theme/guide/markdown/abbr.md
rename to docs/guide/markdown/abbr.md
diff --git a/docs/notes/theme/guide/markdown/annotation.md b/docs/guide/markdown/annotation.md
similarity index 100%
rename from docs/notes/theme/guide/markdown/annotation.md
rename to docs/guide/markdown/annotation.md
diff --git a/docs/notes/theme/guide/markdown/basic.md b/docs/guide/markdown/basic.md
similarity index 100%
rename from docs/notes/theme/guide/markdown/basic.md
rename to docs/guide/markdown/basic.md
diff --git a/docs/notes/theme/guide/markdown/caniuse.md b/docs/guide/markdown/caniuse.md
similarity index 100%
rename from docs/notes/theme/guide/markdown/caniuse.md
rename to docs/guide/markdown/caniuse.md
diff --git a/docs/notes/theme/guide/markdown/card.md b/docs/guide/markdown/card.md
similarity index 100%
rename from docs/notes/theme/guide/markdown/card.md
rename to docs/guide/markdown/card.md
diff --git a/docs/notes/theme/guide/markdown/chat.md b/docs/guide/markdown/chat.md
similarity index 100%
rename from docs/notes/theme/guide/markdown/chat.md
rename to docs/guide/markdown/chat.md
diff --git a/docs/notes/theme/guide/markdown/code-tree.md b/docs/guide/markdown/code-tree.md
similarity index 100%
rename from docs/notes/theme/guide/markdown/code-tree.md
rename to docs/guide/markdown/code-tree.md
diff --git a/docs/notes/theme/guide/markdown/collapse.md b/docs/guide/markdown/collapse.md
similarity index 100%
rename from docs/notes/theme/guide/markdown/collapse.md
rename to docs/guide/markdown/collapse.md
diff --git a/docs/notes/theme/guide/markdown/demo-wrapper.md b/docs/guide/markdown/demo-wrapper.md
similarity index 100%
rename from docs/notes/theme/guide/markdown/demo-wrapper.md
rename to docs/guide/markdown/demo-wrapper.md
diff --git a/docs/notes/theme/guide/markdown/extensions.md b/docs/guide/markdown/extensions.md
similarity index 100%
rename from docs/notes/theme/guide/markdown/extensions.md
rename to docs/guide/markdown/extensions.md
diff --git a/docs/notes/theme/guide/markdown/field.md b/docs/guide/markdown/field.md
similarity index 100%
rename from docs/notes/theme/guide/markdown/field.md
rename to docs/guide/markdown/field.md
diff --git a/docs/notes/theme/guide/markdown/file-tree.md b/docs/guide/markdown/file-tree.md
similarity index 100%
rename from docs/notes/theme/guide/markdown/file-tree.md
rename to docs/guide/markdown/file-tree.md
diff --git a/docs/notes/theme/guide/markdown/flex.md b/docs/guide/markdown/flex.md
similarity index 100%
rename from docs/notes/theme/guide/markdown/flex.md
rename to docs/guide/markdown/flex.md
diff --git a/docs/notes/theme/guide/markdown/icons.md b/docs/guide/markdown/icons.md
similarity index 100%
rename from docs/notes/theme/guide/markdown/icons.md
rename to docs/guide/markdown/icons.md
diff --git a/docs/notes/theme/guide/markdown/include.md b/docs/guide/markdown/include.md
similarity index 100%
rename from docs/notes/theme/guide/markdown/include.md
rename to docs/guide/markdown/include.md
diff --git a/docs/notes/theme/guide/markdown/mark.md b/docs/guide/markdown/mark.md
similarity index 100%
rename from docs/notes/theme/guide/markdown/mark.md
rename to docs/guide/markdown/mark.md
diff --git a/docs/notes/theme/guide/markdown/npm-to.md b/docs/guide/markdown/npm-to.md
similarity index 100%
rename from docs/notes/theme/guide/markdown/npm-to.md
rename to docs/guide/markdown/npm-to.md
diff --git a/docs/notes/theme/guide/markdown/plot.md b/docs/guide/markdown/plot.md
similarity index 100%
rename from docs/notes/theme/guide/markdown/plot.md
rename to docs/guide/markdown/plot.md
diff --git a/docs/notes/theme/guide/markdown/steps.md b/docs/guide/markdown/steps.md
similarity index 100%
rename from docs/notes/theme/guide/markdown/steps.md
rename to docs/guide/markdown/steps.md
diff --git a/docs/notes/theme/guide/markdown/table.md b/docs/guide/markdown/table.md
similarity index 100%
rename from docs/notes/theme/guide/markdown/table.md
rename to docs/guide/markdown/table.md
diff --git a/docs/notes/theme/guide/markdown/tabs.md b/docs/guide/markdown/tabs.md
similarity index 100%
rename from docs/notes/theme/guide/markdown/tabs.md
rename to docs/guide/markdown/tabs.md
diff --git a/docs/notes/theme/guide/markdown/timeline.md b/docs/guide/markdown/timeline.md
similarity index 100%
rename from docs/notes/theme/guide/markdown/timeline.md
rename to docs/guide/markdown/timeline.md
diff --git a/docs/notes/theme/guide/quick-start/blog.md b/docs/guide/quick-start/blog.md
similarity index 100%
rename from docs/notes/theme/guide/quick-start/blog.md
rename to docs/guide/quick-start/blog.md
diff --git a/docs/guide/quick-start/collection-doc.md b/docs/guide/quick-start/collection-doc.md
new file mode 100644
index 00000000..51267046
--- /dev/null
+++ b/docs/guide/quick-start/collection-doc.md
@@ -0,0 +1,359 @@
+---
+title: doc 集合
+icon: streamline-ultimate:sidebar-line-left
+createTime: 2025/10/05 17:11:48
+permalink: /guide/collection/doc/
+---
+
+## 概述
+
+**doc 集合**专为管理结构化文档而设计，适用于文章间存在强关联关系、需要整体呈现的场景。典型应用包括：
+
+- API 技术文档
+- 产品使用教程
+- 专题开发指南
+- 知识体系笔记
+
+该集合通过**智能侧边导航栏**实现文档间的快速跳转与内容组织。
+
+::: info 主题支持配置多个独立的 doc 集合
+:::
+
+## 创建 doc 集合
+
+通过三个步骤快速创建文档集合：
+
+:::: steps
+
+- **创建文档目录**
+
+ ::: file-tree
+ - docs
+ - ++ guide
+ - ++ intro.md
+ - ++ install.md
+ - ++ …
+ :::
+
+- **配置集合参数**
+
+ ::: code-tabs#config
+
+ @tab .vuepress/config.ts
+
+ ```ts twoslash
+ import { defineUserConfig } from 'vuepress'
+ import { plumeTheme } from 'vuepress-theme-plume'
+
+ export default defineUserConfig({
+ theme: plumeTheme({
+ collections: [ // [!code focus:3]
+ { type: 'doc', dir: 'guide', title: '指南' }
+ ]
+ })
+ })
+ ```
+
+ @tab .vuepress/plume.config.ts
+
+ ```ts twoslash
+ import { defineThemeConfig } from 'vuepress-theme-plume'
+
+ export default defineThemeConfig({
+ collections: [ // [!code focus:3]
+ { type: 'doc', dir: 'guide', title: '指南' }
+ ]
+ })
+ ```
+
+ :::
+
+- **完成配置**
+::::
+
+### 多语言支持
+
+为不同语言版本配置独立的文档集合：
+
+::: file-tree
+
+- docs
+ - guide
+ - intro.md
+ - install.md
+ - …
+ - en
+ - guide
+ - intro.md
+ - install.md
+ - …
+:::
+
+::: code-tabs#config
+
+@tab .vuepress/config.ts
+
+```ts twoslash
+import { defineUserConfig } from 'vuepress'
+import { plumeTheme } from 'vuepress-theme-plume'
+
+export default defineUserConfig({
+ theme: plumeTheme({
+ locales: {
+ '/': { // [!code focus:5]
+ collections: [
+ { type: 'doc', dir: 'guide', title: '指南' }
+ ]
+ },
+ '/en/': { // [!code focus:5]
+ collections: [
+ { type: 'doc', dir: 'guide', title: 'Guide' }
+ ]
+ }
+ }
+ })
+})
+```
+
+@tab .vuepress/plume.config.ts
+
+```ts twoslash
+import { defineThemeConfig } from 'vuepress-theme-plume'
+
+export default defineThemeConfig({
+ locales: {
+ '/': { // [!code focus:5]
+ collections: [
+ { type: 'doc', dir: 'guide', title: '指南' }
+ ]
+ },
+ '/en/': { // [!code focus:5]
+ collections: [
+ { type: 'doc', dir: 'guide', title: 'Guide' }
+ ]
+ }
+ }
+})
+```
+
+:::
+
+## 目录结构配置
+
+`dir` 参数定义文档源文件位置，支持相对和绝对路径：
+
+```ts
+dir: 'guide' // 指向 docs/guide
+dir: '/guide/' // 等效写法
+dir: './guide/' // 等效写法
+dir: '/team/guide/' // 指向 docs/team/guide
+```
+
+::: info 多语言环境下路径相对于对应的语言目录
+:::
+
+## 自动 Frontmatter 生成
+
+::: info 仅在执行 `vuepress dev` 或 `vuepress build` 后生效
+:::
+
+支持自动生成文档元数据，可自定义处理逻辑：
+
+::: code-tabs#config
+
+@tab .vuepress/config.ts
+
+```ts
+import { defineUserConfig } from 'vuepress'
+import { plumeTheme } from 'vuepress-theme-plume'
+
+export default defineUserConfig({
+ theme: plumeTheme({
+ collections: [
+ {
+ type: 'doc',
+ dir: 'guide',
+ title: '指南',
+ // [!code hl:10]
+ autoFrontmatter: {
+ title: true, // 自动生成标题
+ createTime: true, // 自动生成创建时间
+ permalink: true, // 自动生成永久链接
+ transform: (data, context, locale) => { // 自定义转换
+ data.foo ??= 'foo'
+ return data
+ }
+ }
+ }
+ ]
+ })
+})
+```
+
+@tab .vuepress/plume.config.ts
+
+``` ts
+import { defineThemeConfig } from 'vuepress-theme-plume'
+
+export default defineThemeConfig({
+ collections: [
+ {
+ type: 'doc',
+ dir: 'guide',
+ title: '指南',
+ // [!code hl:10]
+ autoFrontmatter: {
+ title: true, // 自动生成标题
+ createTime: true, // 自动生成创建时间
+ permalink: true, // 自动生成永久链接
+ transform: (data, context, locale) => { // 自定义转换
+ data.foo ??= 'foo'
+ return data
+ }
+ }
+ }
+ ]
+})
+```
+
+:::
+
+生成效果：
+
+```md title="docs/guide/install.md"
+---
+title: install
+createTime: 2025/03/24 20:15:12
+permalink: /guide/a1b2c3d4/
+---
+```
+
+## 侧边栏配置
+
+提供灵活的侧边栏导航配置选项：
+
+::: code-tabs#config
+
+@tab .vuepress/config.ts
+
+```ts
+import { defineUserConfig } from 'vuepress'
+import { plumeTheme } from 'vuepress-theme-plume'
+
+export default defineUserConfig({
+ theme: plumeTheme({
+ collections: [
+ {
+ type: 'doc',
+ dir: 'guide',
+ title: '指南',
+ // [!code hl:5]
+ sidebar: [ // 手动配置导航项
+ 'intro',
+ 'install',
+ ],
+ sidebarScrollbar: true, // 显示侧边栏滚动条
+ }
+ ]
+ })
+})
+```
+
+@tab .vuepress/plume.config.ts
+
+``` ts
+import { defineThemeConfig } from 'vuepress-theme-plume'
+
+export default defineThemeConfig({
+ collections: [
+ {
+ type: 'doc',
+ dir: 'guide',
+ title: '指南',
+ // [!code hl:5]
+ sidebar: [ // 手动配置导航项
+ 'intro',
+ 'install',
+ ],
+ sidebarScrollbar: true, // 显示侧边栏滚动条
+ }
+ ]
+})
+```
+
+:::
+
+### 自动生成侧边栏
+
+设置 `sidebar: 'auto'` 自动基于目录结构生成导航：
+
+::: code-tabs#config
+
+@tab .vuepress/config.ts
+
+```ts
+import { defineUserConfig } from 'vuepress'
+import { plumeTheme } from 'vuepress-theme-plume'
+
+export default defineUserConfig({
+ theme: plumeTheme({
+ collections: [
+ {
+ type: 'doc',
+ dir: 'guide',
+ title: '指南',
+ // [!code hl]
+ sidebar: 'auto', // 自动生成导航结构
+ sidebarCollapsed: undefined, // 折叠状态：true-折叠 false-展开
+ }
+ ]
+ })
+})
+```
+
+@tab .vuepress/plume.config.ts
+
+``` ts
+import { defineThemeConfig } from 'vuepress-theme-plume'
+
+export default defineThemeConfig({
+ collections: [
+ {
+ type: 'doc',
+ dir: 'guide',
+ title: '指南',
+ // [!code hl]
+ sidebar: 'auto', // 自动生成导航结构
+ sidebarCollapsed: undefined, // 折叠状态：true-折叠 false-展开
+ }
+ ]
+})
+```
+
+:::
+
+### 手动配置侧边栏
+
+[查看**侧边栏**详细配置说明](./sidebar.md){.read-more}
+
+## 集合首页定制
+
+目录下的 `README.md` 自动作为集合首页，支持转换为功能丰富的门户布局：
+
+```md title="typescript/README.md"
+---
+pageLayout: home
+config:
+ - type: hero
+ title: TypeScript 完全指南
+ description: 从基础到进阶的 TypeScript 学习路径
+ - type: features
+ features:
+ - title: 类型系统
+ details: 深入理解 TypeScript 类型系统
+ icon: mdi:code-braces
+ - title: 高级特性
+ details: 掌握泛型、装饰器等高级功能
+ icon: mdi:rocket-launch
+---
+```
diff --git a/docs/guide/quick-start/collection-post.md b/docs/guide/quick-start/collection-post.md
new file mode 100644
index 00000000..110e5aae
--- /dev/null
+++ b/docs/guide/quick-start/collection-post.md
@@ -0,0 +1,852 @@
+---
+title: post 集合
+icon: mdi:post-outline
+createTime: 2025/10/05 17:10:57
+permalink: /guide/collection/post/
+---
+
+## 概述
+
+**post 集合**用于管理碎片化的多篇文章集合。这里的"碎片化"指文章间无强关联关系，或仅需扁平化展示的场景，典型应用包括：
+
+- 博客系统
+- 专题专栏
+- 新闻资讯
+- 随笔记录
+
+该集合提供完整的文章管理功能：
+
+- **文章列表页** - 支持置顶、封面图、摘要展示
+- **文章分类页** - 基于目录结构自动生成分类
+- **文章标签页** - 根据页面 `frontmatter.tags` 生成标签
+- **文章归档页** - 基于 `frontmatter.createTime` 生成时间线归档
+
+各页面均预留个人信息展示区域，支持个人简介或组织信息配置。
+
+::: info 主题支持配置多个 post 集合
+:::
+
+## 创建 post 集合
+
+通过三个简单步骤即可完成 post 集合创建：
+
+:::: steps
+
+- **创建文章目录**
+
+ ::: file-tree
+ - docs
+ - ++ blog
+ - ++ post-1.md
+ - ++ post-2.md
+ - ++ …
+ :::
+
+- **配置集合参数**
+
+ ::: code-tabs#config
+
+ @tab .vuepress/config.ts
+
+ ```ts twoslash
+ import { defineUserConfig } from 'vuepress'
+ import { plumeTheme } from 'vuepress-theme-plume'
+
+ export default defineUserConfig({
+ theme: plumeTheme({
+ collections: [ // [!code focus:3]
+ { type: 'post', dir: 'blog', title: '博客' }
+ ]
+ })
+ })
+ ```
+
+ @tab .vuepress/plume.config.ts
+
+ ```ts twoslash
+ import { defineThemeConfig } from 'vuepress-theme-plume'
+
+ export default defineThemeConfig({
+ collections: [ // [!code focus:3]
+ { type: 'post', dir: 'blog', title: '博客' }
+ ]
+ })
+ ```
+
+ :::
+
+- **完成**
+
+::::
+
+配置完成后，主题自动扫描 `docs/blog` 目录并生成以下页面：
+
+- 文章列表页：`/blog/`
+- 文章分类页：`/blog/categories/`
+- 文章标签页：`/blog/tags/`
+- 文章归档页：`/blog/archives/`
+
+启用 `autoFrontmatter` 后，系统自动为 Markdown 文件生成永久链接：
+
+```md title="docs/blog/post-1.md"
+---
+title: post-1
+createTime: 2025/03/24 20:15:12
+permalink: /blog/a1b2c3d4/
+---
+```
+
+### 多语言支持
+
+在主题多语言配置中定义不同语言的 post 集合：
+
+::: code-tabs#config
+
+@tab .vuepress/config.ts
+
+```ts twoslash
+import { defineUserConfig } from 'vuepress'
+import { plumeTheme } from 'vuepress-theme-plume'
+
+export default defineUserConfig({
+ theme: plumeTheme({
+ locales: {
+ '/': { // [!code focus:5]
+ collections: [
+ { type: 'post', dir: 'blog', title: '博客' }
+ ]
+ },
+ '/en/': { // [!code focus:5]
+ collections: [
+ { type: 'post', dir: 'blog', title: 'Blog' }
+ ]
+ }
+ }
+ })
+})
+```
+
+@tab .vuepress/plume.config.ts
+
+```ts twoslash
+import { defineThemeConfig } from 'vuepress-theme-plume'
+
+export default defineThemeConfig({
+ locales: {
+ '/': { // [!code focus:5]
+ collections: [
+ { type: 'post', dir: 'blog', title: '博客' }
+ ]
+ },
+ '/en/': { // [!code focus:5]
+ collections: [
+ { type: 'post', dir: 'blog', title: 'Blog' }
+ ]
+ }
+ }
+})
+```
+
+:::
+
+## 集合目录配置
+
+`dir` 参数指定集合的源文件目录，支持绝对路径和相对路径（均相对于源目录）：
+
+```ts
+dir: 'blog' // 指向 docs/blog
+dir: '/blog/' // 等效写法
+dir: './blog/' // 等效写法
+dir: '/team/blog/' // 指向 docs/team/blog
+```
+
+::: info 在多语言下，则相对于多语言目录
+:::
+
+### 文件过滤
+
+通过 `include` 和 `exclude` 配置过滤 Markdown 文件，
+使用 [picomatch ::quill:search::](https://chat.baidu.com/search?word=picomatch+%E7%9A%84+glob+pattern+%E8%A7%84%E5%88%99){.no-icon} 模式匹配：
+
+::: code-tabs#config
+
+@tab .vuepress/config.ts
+
+```ts twoslash
+import { defineUserConfig } from 'vuepress'
+import { plumeTheme } from 'vuepress-theme-plume'
+
+export default defineUserConfig({
+ theme: plumeTheme({
+ collections: [
+ {
+ type: 'post',
+ dir: 'blog',
+ title: '博客',
+ // [!code hl:4]
+ include: ['**/*.md'], // 包含所有 .md 文件
+ exclude: ['**/*.snippet.md'] // 排除代码片段文件
+ }
+ ]
+ })
+})
+```
+
+@tab .vuepress/plume.config.ts
+
+```ts twoslash
+import { defineThemeConfig } from 'vuepress-theme-plume'
+
+export default defineThemeConfig({
+ collections: [
+ {
+ type: 'post',
+ dir: 'blog',
+ title: '博客',
+ // [!code hl:4]
+ include: ['**/*.md'], // 包含所有 .md 文件
+ exclude: ['**/*.snippet.md'] // 排除代码片段文件
+ }
+ ]
+})
+```
+
+:::
+
+## 页面生成配置
+
+默认基于 `dir` 配置生成页面路径，支持完整自定义：
+
+::: code-tabs#config
+
+@tab .vuepress/config.ts
+
+```ts twoslash
+import { defineUserConfig } from 'vuepress'
+import { plumeTheme } from 'vuepress-theme-plume'
+
+export default defineUserConfig({
+ theme: plumeTheme({
+ collections: [
+ {
+ type: 'post',
+ dir: 'blog',
+ title: '博客',
+ // [!code hl:16]
+ postList: true, // 启用文章列表页
+ link: '/blog/', // 列表页链接
+ linkPrefix: '/blog/', // 文章链接前缀
+ tags: true, // 启用标签页
+ tagsLink: '/blog/tags/', // 标签页链接
+ tagsTheme: 'colored', // 标签主题 colored|gray|brand
+ tagsText: '标签', // 标签页标题
+ archives: true, // 启用归档页
+ archivesLink: '/blog/archives/', // 归档页链接
+ archivesText: '归档', // 归档页标题
+ categories: true, // 启用分类页
+ categoriesLink: '/blog/categories/', // 分类页链接
+ categoriesText: '分类', // 分类页标题
+ categoriesExpand: 'deep', // 分类展开层级 number|'deep'
+ categoriesTransform: categories => categories, // 分类转换函数
+ }
+ ]
+ })
+})
+```
+
+@tab .vuepress/plume.config.ts
+
+```ts twoslash
+import { defineThemeConfig } from 'vuepress-theme-plume'
+
+export default defineThemeConfig({
+ collections: [
+ {
+ type: 'post',
+ dir: 'blog',
+ title: '博客',
+ // [!code hl:16]
+ postList: true, // 启用文章列表页
+ link: '/blog/', // 列表页链接
+ linkPrefix: '/blog/', // 文章链接前缀
+ tags: true, // 启用标签页
+ tagsLink: '/blog/tags/', // 标签页链接
+ tagsTheme: 'colored', // 标签主题 colored|gray|brand
+ tagsText: '标签', // 标签页标题
+ archives: true, // 启用归档页
+ archivesLink: '/blog/archives/', // 归档页链接
+ archivesText: '归档', // 归档页标题
+ categories: true, // 启用分类页
+ categoriesLink: '/blog/categories/', // 分类页链接
+ categoriesText: '分类', // 分类页标题
+ categoriesExpand: 'deep', // 分类展开层级 number|'deep'
+ categoriesTransform: categories => categories, // 分类转换函数
+ }
+ ]
+})
+```
+
+:::
+
+## 自动 Frontmatter 生成
+
+::: info 仅在执行 `vuepress dev` 或 `vuepress build` 后生效
+:::
+
+支持集合级别的 frontmatter 自动生成，可自定义转换逻辑：
+
+::: code-tabs#config
+
+@tab .vuepress/config.ts
+
+```ts
+import { defineUserConfig } from 'vuepress'
+import { plumeTheme } from 'vuepress-theme-plume'
+
+export default defineUserConfig({
+ theme: plumeTheme({
+ collections: [
+ {
+ type: 'post',
+ dir: 'blog',
+ title: '博客',
+ // [!code hl:10]
+ autoFrontmatter: {
+ title: true, // 自动生成标题
+ createTime: true, // 自动生成创建时间
+ permalink: true, // 自动生成永久链接
+ transform: (data, context, locale) => { // 自定义转换
+ data.foo ??= 'foo'
+ return data
+ }
+ }
+ }
+ ]
+ })
+})
+```
+
+@tab .vuepress/plume.config.ts
+
+``` ts
+import { defineThemeConfig } from 'vuepress-theme-plume'
+
+export default defineThemeConfig({
+ collections: [
+ {
+ type: 'post',
+ dir: 'blog',
+ title: '博客',
+ // [!code hl:10]
+ autoFrontmatter: {
+ title: true, // 自动生成标题
+ createTime: true, // 自动生成创建时间
+ permalink: true, // 自动生成永久链接
+ transform: (data, context, locale) => { // 自定义转换
+ data.foo ??= 'foo'
+ return data
+ }
+ }
+ }
+ ]
+})
+```
+
+:::
+
+生成示例：
+
+```md title="docs/blog/post-1.md"
+---
+title: post-1
+createTime: 2025/03/24 20:15:12
+permalink: /blog/a1b2c3d4/
+---
+```
+
+## 个人信息配置
+
+每个 post 集合支持独立配置个人信息展示区域。未配置时继承[主题默认 profile 设置](../../config/theme.md#profile)。
+
+::: code-tabs#config
+
+@tab .vuepress/config.ts
+
+```ts
+import { defineUserConfig } from 'vuepress'
+import { plumeTheme } from 'vuepress-theme-plume'
+
+export default defineUserConfig({
+ theme: plumeTheme({
+ collections: [
+ {
+ type: 'post',
+ dir: 'blog',
+ title: '博客',
+ // [!code hl:10]
+ profile: {
+ avatar: '/avatar.jpg', // 头像路径
+ name: '张三', // 显示名称
+ description: '个人简介', // 简介文本
+ circle: true, // 圆形头像
+ location: '广州', // 所在地
+ organization: '组织名称', // 所属组织
+ layout: 'right', // 布局位置 left|right
+ }
+ }
+ ]
+ })
+})
+```
+
+@tab .vuepress/plume.config.ts
+
+``` ts
+import { defineThemeConfig } from 'vuepress-theme-plume'
+
+export default defineThemeConfig({
+ collections: [
+ {
+ type: 'post',
+ dir: 'blog',
+ title: '博客',
+ // [!code hl:10]
+ profile: {
+ avatar: '/avatar.jpg', // 头像路径
+ name: '张三', // 显示名称
+ description: '个人简介', // 简介文本
+ circle: true, // 圆形头像
+ location: '广州', // 所在地
+ organization: '组织名称', // 所属组织
+ layout: 'right', // 布局位置 left|right
+ }
+ }
+ ]
+})
+```
+
+:::
+
+## 社交链接
+
+个人信息区域支持社交链接配置，未配置时继承[主题默认 social 设置](../../config/theme.md#social)。
+
+::: code-tabs#config
+
+@tab .vuepress/config.ts
+
+```ts
+import { defineUserConfig } from 'vuepress'
+import { plumeTheme } from 'vuepress-theme-plume'
+
+export default defineUserConfig({
+ theme: plumeTheme({
+ collections: [
+ {
+ type: 'post',
+ dir: 'blog',
+ title: '博客',
+ // [!code hl:4]
+ social: [
+ { icon: 'github', link: 'https://github.com/pengzhanbo' },
+ ],
+ }
+ ]
+ })
+})
+```
+
+@tab .vuepress/plume.config.ts
+
+``` ts
+import { defineThemeConfig } from 'vuepress-theme-plume'
+
+export default defineThemeConfig({
+ collections: [
+ {
+ type: 'post',
+ dir: 'blog',
+ title: '博客',
+ // [!code hl:4]
+ social: [
+ { icon: 'github', link: 'https://github.com/pengzhanbo' },
+ ],
+ }
+ ]
+})
+```
+
+:::
+
+### 内置图标库
+
+::: flex
+
+vuepress@{{ vuepressVersion }}，你应该安装这个版本的 VuePress。高于或低于这个版本，可能会存在潜在的兼容性问题。
- :::
-
-- ### 在 `package.json` 中添加 `script`
-
- ``` json title="package.json"
- {
- "scripts": {
- "docs:dev": "vuepress dev docs",
- "docs:build": "vuepress build docs"
- }
- }
- ```
-
- `vuepress` 默认将文档源码放在 `docs` 目录下。
-
-- ### 将默认的临时目录和缓存目录添加到`.gitignore` 文件中
-
- ::: code-tabs
- @tab .gitignore
-
- ``` txt
- node_modules
- .temp
- .cache
- ```
-
- @tab sh
-
- ``` sh
- echo 'node_modules' >> .gitignore
- echo '.temp' >> .gitignore
- echo '.cache' >> .gitignore
- ```
-
- :::
-
-- ### 在 `docs/.vuepress/config.{js,ts}` 中配置主题
-
- ``` ts title="docs/.vuepress/config.ts" twoslash
- import { viteBundler } from '@vuepress/bundler-vite'
- import { defineUserConfig } from 'vuepress'
- import { plumeTheme } from 'vuepress-theme-plume'
-
- export default defineUserConfig({
- // 请不要忘记设置默认语言
- lang: 'zh-CN',
- theme: plumeTheme({
- // more...
- }),
- bundler: viteBundler(),
- })
- ```
-
- :::warning 不要忘记设置默认语言
- 无论是否需要使用 **多语言** ，你都应该为 VuePress 配置 正确 `lang` 选项值。
- 主题需要根据 `lang` 选项来确定语言环境文本。
- :::
-
-- ### 在 `docs` 目录下新建 `README.md` 文件
-
- 声明首页配置。
-
- ``` md title="README.md"
- ---
- home: true
- ---
- ```
-
-- ### 在本地服务器启动你的文档站点
-
- ::: npm-to
-
- ``` sh
- npm run docs:dev
- ```
-
- :::
-
- VuePress 会在
-
-
-
-
diff --git a/theme/src/client/components/Home/VPHome.vue b/theme/src/client/components/Home/VPHome.vue
index fe4e4da6..69dd992d 100644
--- a/theme/src/client/components/Home/VPHome.vue
+++ b/theme/src/client/components/Home/VPHome.vue
@@ -1,6 +1,5 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+