VuePress Theme Mix

Frontmatter

The following is translated from Chinese by ChatGPT.

In addition to the Frontmatter built into VuePress 2, this theme also provides the following options.

Homepage

home

  • Type: boolean
  • Default: false

Indicates whether the page is the homepage.

heroText

  • Type: string | null
  • Default: The site's title

The main title of the homepage, set to null to disable it.

tagline

The descriptive slogan below the main title of the homepage, set to null to disable it.

actions

  • Type:

    Array<{
  text: string
  link: string
  type?: 'primary' | 'secondary'
}>

Buttons on the homepage.

Example:

---
actions:
  - text: Get Started
    link: /guide/getting-started.html
    type: primary
  - text: View on GitHub
    link: https://github.com/gavinliu6/vuepress-theme-mix
    type: secondary
---

features

  • Type:

    Array<{
  title: string
  details: string
}>

Describes the features of your site.

  • Type: string
  • Default: None

Footer of the homepage.

General pages

toc

Same as the theme configuration option toc, with higher priority.

Same as the theme configuration option editLink, with higher priority.

lastUpdated

Same as the theme configuration option lastUpdated, with higher priority.

contributors

Same as the theme configuration option contributors, with higher priority.

Same as the theme configuration option sidebar, with higher priority.

sidebarDepth

Same as the theme configuration option sidebarDepth, with higher priority.

prev & next

  • Type: string | NavLink
// Type definitions

interface NavLink {
  text: string
  ariaLabel?: string
  link: string
  rel?: string
  target?: string
  activeMatch?: string
}

Links to the previous and next pages at the bottom of the page. If these two options are not set, the link will be automatically inferred based on the sidebar configuration.

On this page