Skip to content

Front matter options

Jump to bottom
Brian Hurst edited this page May 2, 2019 · 2 revisions

There are a handful of front matter options that can help you in formatting the layout of a page.

  • title (required) - all pages must contain a title. This value is shown in the main heading on the page, as well and within the browser's tab and bookmarks.
  • permalink - this is a special value that formats the url of the webpage. In most cases, these should be left as-is, otherwise it could potentially break the site's navigation.
  • anchors - read more about anchors
  • no_top_link - if this is set to true, then the Return to top link found in the footer of every page will be hidden (useful for very short pages).
  • layout - by default this is set to page, which is the standard layout, but it can also be overridden and set to full which will hide the side navigation (such as on the Privacy policy page).
  • skip_index - if this is set to true, then the page will not be included in the site search results

On some pages, such as the homepage, there is page specific front matter that can be modified to change the content of the page. This is sometimes used when there are complex layouts (such as on the homepage) so that the markdown files do not become cluttered with HTML tags.

Clone this wiki locally