博客配置

介绍

主题通过 @vuepress/plugin-blog 提供博客功能，默认情况下此功能不启用。

你可以在主题选项中设置 plugins.blog: true 来启用博客功能。

有关说明，请参阅博客介绍。

选项

plugins.blog.excerptboolean

默认值true

是否生成摘要。

plugins.blog.excerptSeparatorstring

默认值<!-- more -->

摘要分隔符。

plugins.blog.excerptLengthnumber

默认值300

自动生成的摘要的长度。

注

摘要的长度会尽可能的接近这个值。如果设置为 0，意味着不自动生成摘要。

plugins.blog.filter(page: Page) => boolean

页面过滤器，此函数用于鉴别页面是否作为文章。

默认情况下，所有从 Markdown 源文件中生成的非主页页面，会被作为文章。

其默认值为：

({ frontmatter, filePathRelative }) =>
  frontmatter.article ?? (Boolean(filePathRelative) && !frontmatter.home);

plugins.blog.excerptFilter(page: Page) => boolean

默认值 filter 选项

页面过滤器，此函数用于鉴别插件是否需要生成摘要。

plugins.blog.slugify(name: string) => string

默认值(name) => name.replace(/ _/g, '-').replace(/[:?*|\\/<>]/g, "").toLowerCase()

Slugify 函数，用于转换 key 在路由中注册的形式。

plugins.blog.typeBlogTypeOptions[]

默认值[]

额外的文章类型。

参考：指南 → 文章列表。

plugins.blog.type[*].key必填string

唯一的类型名称。

plugins.blog.type[*].filter必填(page: Page) => boolean

一个过滤函数来决定页面是否满足此类型。

plugins.blog.type[*].sorter(pageA: Page, pageB: Page) => number

页面排序器。

plugins.blog.type[*].pathstring | false

默认值/:key/

待注册的页面路径，设置为 false 以禁用类型页面。

plugins.blog.type[*].layoutstring

默认值Blog

页面布局组件名称。

plugins.blog.type[*].frontmatter(localePath: string) => Record<string, string>

frontmatter 配置。

plugins.blog.articlestring

默认值/article/

文章列表路由路径。

plugins.blog.categorystring

默认值/category/

分类地图路由路径。

plugins.blog.categoryItemstring

默认值/category/:name/

分类列表路由路径。:name 会被自动替换为分类名称。

plugins.blog.tagstring

默认值/tag/

标签地图路由路径。

plugins.blog.tagItemstring

默认值/tag/:name/

标签列表路由路径。:name 会被自动替换为标签名称。

plugins.blog.starstring

默认值/star/

星标文章列表路由路径。

plugins.blog.timelinestring

默认值/timeline/

时间线列表路由路径。

plugins.blog.hotReloadboolean

默认值 是否在使用 --debug 标识

是否需要在开发服务器启用热更新。