.md pages can be configured using the page metadata section added to the top of the page.
--- label: Sample layout: page order: 100 --- # Sample page This is a sample page demonstrating page metadata.
If you would prefer to keep the page metadata separated and placed outside of the
.md content page, the options can be moved into a paired
sample.md would need a matching
sample.yml file. The separate
.yml file must have the exact same filename as the matching
.yaml extensions are supported.
Adding your configs into the top metadata section of a
.md page, or into a separate
.yml file is just a matter of preference. Both techniques produce the same result.
# Sample page This is a sample page demonstrating page metadata.
label: Sample layout: page order: 100
If you add a config to both locations, the page metadata take precedence.
See Folder configuration for details on how to configure a folder.
A custom description of the current page.
description: This is a custom description for this page
Determines whether this folder should be expanded in the tree navigation on initial page load. Default is
true to expand the folder node in the navigation.
expanded option only applies to folders when configured within an
index.yml folder configuration file.
expanded: true within the metadata of an
.md page or the paired
.yml file will be ignored.
Custom icon for the navigation node of the current page. Default is
Custom label for the navigation node for the current page. Default is
title: Custom label
The layout for the page. Default is
||The default layout for all
||A page with no left or right sidebar columns.|
||A blog page layout. Blog pages are not added to the main navigation and include blog specific
A custom stack order within the navigation.
Options can include:
- A number such as
- Any string value that will be slotted into the
A -> Zalpha ordering of all navigation nodes
- A SemVer value such as
In order of precedence, the
order would be applied by:
number (high) alpha (a) neutral (by alpha) alpha (z) vSemver (newest) vSemver (oldest) number (low)
Order by number
Larger number = order higher in the stack.
No order number or
0 = order by alpha
Smaller number = order lower in the stack.
If multiple pages have the same
order number, secondary ordering in that cluster is by alpha.
+ 0 -
Order by alpha
Order values by alpha.
a = higher
z = lower
Alpha Bravo Charlie Zulu
Order by semver with latest release at the top
v5.0.1 v5 v4.0 v3.1 v3.0 v2.0 v1.0
Items prefixed with
v and mixed with other alpha values would be grouped at the end of
alpha bravo yankee zulu v3.0 v2.1-beta v2.0 v1.0 v1.0-beta v1.0-alpha