Info Frontmatter Config

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

Options

titlestring

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

shortTitlestring

Current page's short title. It will be used as the preferred title in navbar, sidebar and breadcrumb.

descriptionstring

Current page's description.

iconstring

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

See also: Interface → Icon Support.

authorAuthor | boolean

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.

See also: Feature → Page Info.

Its type is:

type AuthorName = string;

interface AuthorInfo {
  /**
   * Author name
   */
  name: string;

  /**
   * Author website
   */
  url?: string;

  /**
   * Author email
   */
  email?: string;
}

type Author = AuthorName | AuthorName[] | AuthorInfo | AuthorInfo[];

isOriginalboolean

Whether the current article is original.

See also: Feature → Page Info.

dateDateString

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

See also: Feature → Page Info.

categorystring | string[]

Set the category of the current page.

See also: Feature → Page Info.

tagstring | string[]

Set the label of the current page.

See also: Feature → Page Info.

licensestring

Default value in theme options

License name of the page.

See also: Layout → Footer.

copyrightstring | false

Default value in theme options

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

See also: Layout → Footer.

pageviewboolean

Default value in theme options

Whether display page views.

Tips

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

See also: Feature → Comment.

articleboolean

Defaulttrue

Whether to add the article to the article list.

See also: Blog → Article.

timelineboolean

Defaulttrue

Whether to add the article to the timeline list.

See also: Blog → Timeline.

stickyboolean | number

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

See also: Blog → Article.

starboolean | number

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.

See also: Blog → Article.

coverstring

Cover image of the page.

See also: FAQ → Links in Config.

bannerstring

Banner image of the page.

See also: FAQ → Links in Config.