Blog Plugin Config

Intro

The theme provides blog feature via @vuepress/plugin-blog, and it's not enabled by default.

You can enable blog feature by setting plugins.blog to true in theme options.

For instructions, please see Blog Intro.

Options

plugins.blog.excerptboolean

Defaulttrue

Whether generate excerpt for page.

plugins.blog.excerptSeparatorstring

Default<!-- more -->

Separator used to split excerpt from page content.

plugins.blog.excerptLengthnumber

Default300

Length of excerpt when auto generating.

Note

The length of the excerpt will be as close as possible to this value. If it is set to 0, it means no excerpt will be generated automatically.

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

Page filter, determine whether a page should be included.

By default, all the pages generated from Markdown files but not homepage will be included as articles.

Its default value is:

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

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

Default filter option

Page filter, determine whether the plugin should generate excerpt for it.

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

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

Slugify function, used to convert key name which they are register in routes.

plugins.blog.typeBlogTypeOptions[]

Default[]

Additional article type.

See also: Guide → Article List.

plugins.blog.type[*].keyRequiredstring

Unique type name.

plugins.blog.type[*].filterRequired(page: Page) => boolean

A filter function to determine whether a page should be the type.

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

A custom function to sort the pages.

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

Default/:key/

Page path to be registered, set to false to disable the type page.

plugins.blog.type[*].layoutstring

DefaultBlog

Layout name.

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

Frontmatter.

plugins.blog.articlestring

Default/article/

Article list route path.

plugins.blog.categorystring

Default/category/

Category map route path.

plugins.blog.categoryItemstring

Default/category/:name/

Category list route path. :name will be replaced by category name.

plugins.blog.tagstring

Default/tag/

Tag map route path.

plugins.blog.tagItemstring

Default/tag/:name/

Tag list route path. :name will be replaced by tag name.

plugins.blog.starstring

Default/star/

Star article list route path.

plugins.blog.timelinestring

Default/timeline/

Timeline list route path.

plugins.blog.hotReloadboolean

Default Whether using --debug flag

Whether to enable hot reload in the development server.