Page

Icon Support

You can set icon in page frontmatter to set icon for a page, see Icon Support for details.

This icon is used in navbar, sidebar, breadcrumb and page title.

Example

---
icon: home
---

Breadcrumb

The theme provides out-of-the-box support for breadcrumb navigation.

You can control the display of breadcrumb globally and on specific pages by setting a boolean value through breadcrumb in theme options and page frontmatter.

The icon of the breadcrumb is also configurable. You can control the behavior of the global and specific pages by setting a boolean value through breadcrumbIcon in theme options and page frontmatter.

If you don't want a page to be added to the breadcrumb (e.g., the homepage), you can set breadcrumbExclude: true in frontmatter of that page.

Page Info Display

Please see Page Info Section

Header List

In desktop mode, a list of article headers will automatically be displayed on the right side of the screen. (They will be placed in the sidebar on mobile devices)

If you don't want to display the title list on the right in desktop mode, please set toc: false in theme options.

You can also set it through toc in page frontmatter.

Customizing TOC headers

You can customize TOC headers by setting an object toc in theme options and page frontmatter, the object might contain the following properties:

• selector: The selector of the headers.

  The default value is "#markdown-content > h1, #markdown-content > h2, #markdown-content > h3, #markdown-content > h4, #markdown-content > h5, #markdown-content > h6, [vp-content] > h2".

• depth: The levels of the headers.

  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(default): same as [2, 6], which means all headings from <h2> to <h6> will be displayed.

• ignore: Ignore specific elements within the header, should be an array of strings, the default value is [".vp-badge", ".vp-icon"].

Contributors and Last Updated Time

Please see Page Meta.

Prev / Next Links

Prev and next links are automatically inferred based on the sidebar order of the active page. You can also explicitly overwrite or disable them globally with theme config or on specific pages using Front matter:

---
prev: ./some-other-page
next: false
---

You can also fully customize it by passing an object containing text, icon and link.

Comment

Please see Comment section for details.

Customize Layout

By default, the content of each *.md file is rendered in a <div class="page"> container, along with the sidebar, auto-generated edit links and previous/next links. To use a fully custom component in place of the page, you can again specify the component using frontmatter:

---
layout: SpecialLayout
---

This will render SpecialLayout layout registered in VuePress for the given page.

Note

The theme only provides Layout, 404 layout.

Also the theme:

• Provides a Blog layout when the blogging feature is enabled
• Provides a Slide layout when the slideshow feature is enabled

If you want to provide your own layout, please add them in client config files.

Customize Container Class

By default, each page is rendered in a div with class theme-container. To apply some special styles to specific pages, you can additionally specify a class name by setting containerClass in frontmatter

---
containerClass: fancy-container
---

This will render in <div class="theme-container fancy-container" /> for the current page.