Layout Frontmatter Config

You can configure page layout by setting the following frontmatter options.

Options

pageInfoPageInfo[] | false

Default value in theme options

Customize page info items in current page.

See also: Feature → PageInfo.

Item	Corresponding Content	Page frontmatter Value
"Author"	Author	author
"Date"	Writing Date	date
"Category"	Category	category
"Tag"	Tags	tag
"ReadingTime"	Expect reading time	N/A (automatically generated)
"Word"	Word count	N/A (automatically generated)
"PageView"	Visit Number	pageview (only available with Waline)

breadcrumbboolean

Default value in theme options

Whether enable breadcrumb.

See also: Layout → Page.

breadcrumbIconboolean

Default value in theme options

Whether show icons in breadcrumb.

See also: Layout → Page.

breadcrumbExcludeboolean

Whether to exclude the current page from the breadcrumb.

See also: Layout → Page.

navbarboolean

Setting it to false will disable navbar.

See also: Layout → Navbar.

sidebarfalse | SidebarArrayOptions

Setting it to false will disable sidebar, setting it to empty array [] will render sidebar slots content only.

See also: Layout → Sidebar.

indexboolean

Defaulttrue

Whether index current page in sidebar and catalog.

ordernumber

Page order in sidebar and catalog.

• By filling in a positive number, the page will appear in the front, while the smaller number comes to the front.
• By filling in a negative number, the page will appear in the end, while the greater number comes to the front. (e.g. -1 is after -2)

dir

Sidebar group information used for structure sidebar.

dir.textstring

Default title of README.md

Group title.

dir.iconstring

Default icon of README.md

Group icon.

dir.collapsibleboolean

Defaulttrue

Whether group is collapsible.

dir.linkboolean

Whether Dir is clickable.

Note

Setting to true means setting group link to link of README.md.

dir.indexboolean

Defaulttrue

Whether index current dir.

dir.ordernumber

Group order in sidebar.

• By filling in a positive number, the page will appear in the front, while the smaller number comes to the front.
• By filling in a negative number, the page will appear in the end, while the greater number comes to the front. (e.g. -1 is after -2)

commentboolean

Default value in theme options

Whether to enable comments on the current page.

lastUpdatedboolean

Default value in theme options

Whether to display lastUpdated time.

editLinkboolean

Default value in theme options

Whether to show edit link.

contributorsboolean

Default value in theme options

Whether to show contributors.

changelogboolean

Default value in theme options

Whether to display changelog.

prevAutoLinkConfig | string | false

Previous article link.

prev.textRequiredstring

Link text.

prev.iconRequiredstring

Link icon.

prev.linkRequiredstring

Link address.

nextAutoLinkConfig | string | false

Next article link.

next.textRequiredstring

Link text.

next.iconRequiredstring

Link icon.

next.linkRequiredstring

Link address.

footerboolean | string | HTMLString

Default the value configured globally

Footer content.

• Set it to an empty string if you want an empty content.
• Set it to false to disable the footer.
• Set it to true to display the default footer.

See also: Page → Footer Support.

copyrightstring | false

Default value in theme options

Copyright information.

See also: Page → Footer Support.

backToTopboolean

Defaulttrue

Whether display the back to top button.

tocGetHeadersOptions | boolean

Default value in theme options

Whether display toc.

toc.selectorstring

Default"#markdown-content > h1, #markdown-content > h2, #markdown-content > h3, #markdown-content > h4, #markdown-content > h5, #markdown-content > h6, [vp-content] > h2"

The selector of the headers.

toc.ignorestring[]

Default[".vp-badge", ".vp-icon"]

Ignore specific elements within the header, should be an array of CSS Selector.

toc.levelsHeaderLevels

Default"deep"

The levels of the headers, where HeaderLevels is false, a number, a [number, number] tuple or "deep".

• 1 to 6 for <h1> to <h6>.
• false: No headers.
• number: only headings of that level will be displayed.
• [number, number]: headings level tuple, where the first number should be less than the second number, for example, [2, 4] which means all headings from <h2> to <h4> will be displayed.
• deep: same as [2, 6], which means all headings from <h2> to <h6> will be displayed.

containerClassstring

Extra container class.

layoutstring

Default"Layout"

Page custom layout name.