Content organization

    Note: Hugo Tip: Start Hugo with for content edit-sessions.

    The documentation side menu, the documentation page browser etc. are listed using Hugo’s default sort order, which sorts by weight (from 1), date (newest first), and finally by the link title.

    Given that, if you want to move a page or a section up, set a weight in the page’s front matter:

    Note: For page weights, it can be smart not to use 1, 2, 3 …, but some other interval, say 10, 20, 30… This allows you to insert pages where you want later. Additionally, each weight within the same directory (section) should not be overlapped with the other weights. This makes sure that content is always organized correctly, especially in localized content.

    The Documentation main menu is built from the sections below docs/ with the main_menu flag set in front matter of the _index.md section content file:

    1. main_menu: true

    Note: The above needs to be done per language. If you don’t see your section in the menu, it is probably because it is not identified as a section by Hugo. Create a _index.md content file in the section folder.

    The documentation side-bar menu is built from the current section tree starting below docs/.

    It will show all sections and their pages.

    If you don’t want to list a section or page, set the toc_hide flag to in front matter:

    1. toc_hide: true

    When you navigate to a section that has content, the specific section or page (e.g. _index.md) is shown. Else, the first page inside that section is shown.

    If you don’t want to list a section or page, set the toc_hide flag to true in front matter:

    The site links in the top-right menu — and also in the footer — are built by page-lookups. This is to make sure that the page actually exists. So, if the case-studies section does not exist in a site (language), it will not be linked to.

    In addition to standalone content pages (Markdown files), Hugo supports .

    One example is Custom Hugo Shortcodes. It is considered a leaf bundle. Everything below the directory, including the index.md, will be part of the bundle. This also includes page-relative links, images that can be processed etc.:

    1. en/docs/home/contribute/includes
    3. ├── index.md
    4. └── podtemplate.json

    Another widely used example is the includes bundle. It sets headless: true in front matter, which means that it does not get its own URL. It is only used in other pages.

    • For translated bundles, any missing non-content files will be inherited from languages above. This avoids duplication.
    • All the files in a bundle are what Hugo calls Resources and you can provide metadata per language, such as parameters and title, even if it does not supports front matter (YAML files etc.). See .
    • The value you get from .RelPermalink of a Resource is page-relative. See Permalinks.

    The SASS source of the stylesheets for this site is stored in assets/sass and is automatically built by Hugo.