Searching...

Matching results

    Front Matter

    The front matter is one of the features that gives Hugo its strength. It enables us to include the meta data of the content right with it. We will use it to categorize the content and provide other kind of info to add some magic :)

    Initializing Table Of Contents...

    TOML format

    The “front matter” format we use is named TOML. It is delimited with +++.

    Example:

    +++
title = "Register"
type = "reference"
groups = ["reference"]
promoted = true
weight = 10
+++

    Supported metadata

    title

    Example:

    +++
title = "Front Matter"
+++

    Mandatory, it is used as browser page title and as the 1st level header.

    type

    Example:

    +++
type = "faq"
+++

    Optional, used to identify the kind of a page and use a specific template. The supported types of page are:

    • faq
    • overview
    • whatsnews
    • linkedreference

    faq

    • Use it for FAQ pages
    • TOC is added automatically
    • Level 3 header for the questions

    overview

    • Use it for Overview pages
    • Just the introduction part is customizable
    • Getting Started, What’s New and References are automatically generated

    whatsnews

    • This type is used once per guide
    • All the page content is computed
      • Displays the latest What’s New page
      • With a last section proposing the list of older ones

    linkedreference

    TBD

    groups

    Example:

    +++
groups = ["whatsnew"]
+++

    Groups are used to gather together similar pages to classify them, it’s the concept of Taxonomies.

    Available groups are:

    • whatsnew
      • Used to automatically generate Overview and What’s New pages
    • reference
      • Used to automatically generate Overview pages
    • gettingstarted
      • Used to automatically generate Overview pages

    tags

    Example:

    +++
tags = ["issue", "faq", "problem", "connection"]
+++

    Tags are another kind of Taxonomies, they are used by the search engine to prioritize the results.

    Let’s say you have 2 pages mentionning the word “authentication” and only one them has the tag “authentication”. If your search term is “authentication” the page with the tag will have a higher rank level than the other.

    weight

    Example:

    +++
weight = 10
+++

    Weights are used to sort pages in a group or tag.

    promoted

    Example:

    +++
promoted = true
+++

    It is used to identify the pages we want to link from the Overview page. It is currently only used for Reference pages.

    TOP