Landing pages

Overview

Landing pages (_index.md files) are rendered using our list.html layout.

Default landing page

If _index.md_ contains only frontmatter, with no content or f5-landing-page: true, it will render a list of the content.

The most basic _index.md example:

---
title: Default landing page
f5-subtitle: This is a subtitle for a landing page
---

This will render the default landing page.

This page shows cards with the title of each page, along with its description, if it’s set.

This page will not get linked to in the sidebar. It can only be accessed through the link in the breadcrumb, or if you have the direct link.

Custom landing page

If the _index.md file contains the f5-landing-page: true frontmatter field, and you add some content, you can customize the contents on this page.

The page will also be added to the sidebar with the name of Overview under a section.

This can be treated like any other content page, and supports all expected shortcodes.

---
title: Custom landing page
f5-landing-page: true
f5-subtitle: This is a subtitle for a landing page
---

This is a custom landing page.
This page will not render the default list.

Will render the following custom landing page.

Note that the Overview section for this page is visible in the sidebar, unlike the default landing page.

Custom subtitle

Regardless of using default or custom landing pages, f5-subtitle can be used to add a custom subtitle.