配置
插件选项
getInfo
- 类型:
(page: Page) => Record<string, unknown> - 必填: 否
- 详情:
获取文章信息的函数。
获取到的信息会被稍后注入至路由元数据，以便你可以在客户端中通过组合式 API 获取。
filter
- 类型:
(page: Page) => boolean - 默认值:
(page) => Boolean(page.filePathRelative) && !page.frontmatter.home - 详情:
页面过滤器，此函数用于鉴别页面是否作为文章。
默认情况下，所有从 Markdown 源文件中生成的非主页页面，会被作为文章。
category
- 类型:
BlogCategoryOptions[] - 必填: 否
- 详情:
博客分类配置，详见 博客分类配置。
type
- 类型:
BlogTypeOptions[] - 必填: 否
- 详情:
博客分类配置，详见 博客类型配置。
slugify
- 类型:
(name: string) => string - 默认值:
(name) => name.replace(/ _/g, '-').replace(/[:?*|\\/<>]/g, "").toLowerCase()
Slugify 函数，用于转换 key 在路由中注册的形式。
excerpt
- 类型:
boolean - 默认值:
true
是否生成摘要。
excerptSeparator
- 类型:
string - 默认值:
<!-- more -->
摘要分隔符。
excerptLength
- 类型:
number - 默认值:
300 - 详情:
自动生成的摘要的长度。
注
摘要的长度会尽可能的接近这个值。如果设置为 0，意味着不自动生成摘要。
excerptFilter
- 类型:
(page: Page) => boolean - 默认值:
filter选项 - 详情:
页面过滤器，此函数用于鉴别插件是否需要生成摘要。
提示
你可以使用此函数来跳过你不需要生成摘要的页面。例如：如果用户在 frontmatter 中设置了 excerpt 或 description，你可能希望直接使用它们。
isCustomElement
- 类型:
(tagName: string) => boolean - 默认值:
() => false - 详情:
被认为是自定义元素的标签。
用于判断一个标签是否是自定义元素，因为在摘要中，所有的未知标签都会被移除。
metaScope
- 类型:
string - 默认值:
"_blog"
注入文章信息至路由元数据时使用的键名。
注
设置为空字符串会直接注入路由元数据 (而不是一个键下)。
hotReload
- 类型:
boolean - 默认值: 是否使用
--debug标记
是否在开发服务器中启用实时热重载。
致主题开发者
默认情况下它是禁用的，因为它确实会对具有很多分类和类别的站点产生性能影响，并且在编辑 Markdown 时会减慢热重载的速度。
如果用户正在添加或组织类别或标签，你可以告诉他们启用此功能，其余的时间最好禁用它。
此外，你可以尝试检测用户项目中的页面数并决定是否启用它。
博客分类配置
博客分类配置应为一个数组，每一项控制一个分类规则。
interface BlogCategoryOptions {
/**
* 唯一的分类名称
*/
key: string;
/**
* 从页面中获取分类的函数
*/
getter: (page: Page) => string[];
/**
* 页面排序器
*/
sorter?: (pageA: Page, pageB: Page) => number;
/**
* 待注册的页面路径图案
*
* @description `:key` 将会被替换为原 key 的 slugify 结果
*
* @default `/:key/`
*/
path?: string | false;
/**
* 页面布局组件名称
*
* @default 'Layout'
*/
layout?: string;
/**
* Front Matter 配置
*/
frontmatter?: (localePath: string) => Record<string, string>;
/**
* 待注册的项目页面路径图案或自定义函数
*
* @description 当填入字符串的时候, `:key` 和 `:name` 会被自动替换为原始的 key、name 的 slugify 结果。
*
* @default `/:key/:name/`
*/
itemPath?: string | ((name: string) => string) | false;
/**
* 项目页面布局组件名称
*
* @default 'Layout'
*/
itemLayout?: string;
/**
* 项目 Front Matter 配置
*/
itemFrontmatter?: (
name: string,
localePath: string,
) => Record<string, string>;
}
博客类型配置
博客类型配置应为一个数组，每一项控制一个类型规则。
interface BlogTypeOptions {
/**
* 唯一的类型名称
*/
key: string;
/**
* 一个过滤函数来决定页面是否满足此类型
*/
filter: (page: Page) => boolean;
/**
* 页面排序器
*/
sorter?: (pageA: Page, pageB: Page) => number;
/**
* 待注册的页面路径
*
* @default '/:key/'
*/
path?: string | false;
/**
* 页面布局组件名称
*
* @default 'Layout'
*/
layout?: string;
/**
* Front Matter 配置
*/
frontmatter?: (localePath: string) => Record<string, string>;
}
可组合式 API
你可以从 vuepress-plugin-blog2/client 导入下列 API:
博客分类
const useBlogCategory: < T extends Record<string, unknown> = Record<string, unknown>, >( key?: string, ) => ComputedRef<BlogCategoryData<T>>;参数
key为需要获取的键名。如果未传入 key，会尝试使用与当前路径匹配的 key。博客类型
const useBlogType: < T extends Record<string, unknown> = Record<string, unknown>, >( key?: string, ) => ComputedRef<BlogTypeData<T>>;参数
key为需要获取的键名。如果未传入 key，会尝试使用与当前路径匹配的 key。
详细的返回值如下:
interface Article<T extends Record<string, unknown> = Record<string, unknown>> {
/** 文章路径 */
path: string;
/** 文章信息 */
info: T;
}
interface BlogCategoryData<
T extends Record<string, unknown> = Record<string, unknown>,
> {
/** 分类路径 */
path: string;
/**
* 仅当当前路径和某个子项目匹配时可用
*/
currentItems?: Article<T>[];
/** 分类映射 */
map: {
/** 当前分类下全局唯一的 key */
[key: string]: {
/** 对应键值的分类路径 */
path: string;
/** 对应键值的项目 */
items: Article<T>[];
};
};
}
interface BlogTypeData<
T extends Record<string, unknown> = Record<string, unknown>,
> {
/** 类别路径 */
path: string;
/** 当前类别下的项目 */
items: Article<T>[];
}