Info Frontmatter Config

You can set information for page with the following frontmatter options.

title

• Type: string
• Required: No

Current page's title. Markdown's first h1 by default.

shortTitle

• Type: string
• Required: No

Current page's short title. Will be used as in navbar, sidebar and breadcrumb.

description

• Type: string
• Required: No

Current page's description.

icon

• Type: string
• Required: No
• Details:
  • Interface → Icon Support

FontClass / Image link of the current page icon (recommended).

author

• Type: Author | boolean

  type AuthorName = string;
  
  interface AuthorInfo {
    /**
     * Author name
     */
    name: string;
  
    /**
     * Author website
     */
    url?: string;
  
    /**
     * Author email
     */
    email?: string;
  }
  
  type Author = AuthorName | AuthorName[] | AuthorInfo | AuthorInfo[];

• Required: No

• Details:

  • Feature → Page Info

Show the author of the current page. If you don't fill it, you will fall back to the default author.

Tips

When setting default author in theme options, you can set false to prevent showing the default author.

isOriginal

• Type: boolean
• Default: false
• Details:
  • Feature → Page Info

Whether the current article is original.

date

• Type: DateString
• Required: No
• Details:
  • Feature → Page Info

Set the writing time of the current page, with YYYY-MM-DD or YYYY-MM-DD hh:mm:ss format

category

• Type: string | string[]
• Required: No
• Details:
  • Feature → Page Info

Set the category of the current page.

tag

• Type: string | string []
• Required: No
• Details:
  • Feature → Page Info

Set the label of the current page.

license

• Type: string
• Default: value in theme options
• Details:
  • Layout → Footer.

License name of the page.

copyright

• Type: string | false
• Default: value in theme options
• Details:
  • Layout → Footer.

The copyright information of the page, will be displayed in footer

pageview

• Type: boolean
• Default: value in theme options
• Details:
  • Feature → Comment

Whether display page views.

Tips

The pageview feature requires you to have a valid Waline Comment Service config.

article

• Type: boolean
• Default: true
• Details:
  • Blog → Article.

Whether to add the article to the article list.

timeline

• Type: boolean
• Default: true
• Details:
  • Blog → Timeline.

Whether to add the article to the timeline list.

sticky

• Type: boolean | number
• Default: false
• Details:
  • Blog → Article.

Sets whether the current article is pinned in the list. When fill in with number, greater ones come before smaller ones.

star

• Type: boolean | number
• Default: false
• Details:
  • Blog → Article.

Sets whether the current article is pinned in the article list in blog theme. When fill in with number, greater ones come before smaller ones.

cover

• Type: string
• Required: No
• Details:
  • FAQ → Links in Config

Cover image of the page.

banner

• Type: string
• Required: No
• Details:
  • FAQ → Links in Config

Banner image of the page.