Frontmatter

    Between these triple-dashed lines, you can set predefined variables (see below for a reference), or even create custom ones of your own. These variables will then be available to you to access using at the rest of the page, plus all custom and theming components.

    TIP

    frontmatter variables are optional in VuePress.

    VuePress also supports JSON or frontmatter.

    JSON frontmatter needs to start and end in curly braces:

    • Type: string
    • Default: h1_title || siteConfig.title

    Title of current page.

    lang

    • Type: string
    • Default: en-US

    Language of current page.

    description

    • Type: string
    • Default: siteConfig.description

    Description of current page.

    • Type: string
    • Default:

    Set the layout component of the current page.

    • Type: string

    Refer to: .

    metaTitle

    • Type: string
    • Default: ${page.title} | ${siteConfig.title}
    • Type: array
    • Default: undefined

    Specify extra meta tags to be injected:

    navbar

    • Type:
    • Default: undefined

    See: Default Theme Config > Disable the Navbar.

    sidebar

    • Type: boolean|'auto'
    • Default: undefined

    See: Default Theme Config > Sidebar.

    • Type: boolean|string
    • Default: undefined

    See: .

    next

    • Type: boolean|string

    See: .