# Frontmatter

# lang

  • Type: string

  • Details:

    Language for the page.

    This will override the lang option in your site config.

  • Also see:

# title

  • Type: string

  • Details:

    Title for the page.

    If you don't specify title in frontmatter, content of the first level-one header (i.e. # title) will be used as the title.

# description

  • Type: string

  • Details:

    Description for the page.

    This will override the description option in your site config.

  • Also see:

  • Type: HeadConfig[]

  • Details:

    Extra tags in <head> tag for the page.

  • Example:

    head:
      - - meta
        - name: foo
          content: bar
      - - link
        - rel: canonical
          href: foobar
    
    1
    2
    3
    4
    5
    6
    7

    Rendered as:

    <head>
      <meta name="foo" content="bar" />
      <link rel="canonical" href="foobar" />
    </head>
    
    1
    2
    3
    4
  • Also see:

# date

# permalinkPattern

  • Type: string

  • Details:

    Pattern to generate permalink for the page.

    This won't take effect if the permalink frontmatter has been set.

  • Usage:

    PatternDescription
    :yearYear part of created date
    :monthMonth part of created date
    :dayDay part of created date
    :slugSlug of page filename
    :rawRaw route path

    The :year, :month and :day patterns are resolved according to the following priority:

    • The date frontmatter.
    • The filename that matches the date pattern yyyy-MM-dd-foobar.md or yyyy-MM-foobar.md.
    • The dirname that matches the date pattern yyyy/MM/dd/foobar.md or yyyy/MM/foobar.md.
    • Fallback to 1970-01-01.
  • Example:

    • Case 1:

      The page filename is foo-bar.md.

      The page frontmatter is:

      ---
      date: 2021-01-03
      permalinkPattern: :year/:month/:day/:slug.html
      ---
      
      1
      2
      3
      4

      Then the permalink of the page would be 2021/01/03/foo-bar.html.

    • Case 2:

      The page filename is 2021-01-03-bar-baz.md.

      The page frontmatter is:

      ---
      permalinkPattern: :year/:month/:day/:slug.html
      ---
      
      1
      2
      3

      Then the permalink of the page would be 2021/01/03/bar-baz.html.

  • Also see:

# layout

  • Type: string

  • Details:

    Layout for the page.