# Page configuration

Individual .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.

# Separate .yml configuration

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 .yml file.

For instance, sample.md would need a matching sample.yml file. The separate .yml file must have the exact same filename as the matching .md page.

Both .yml and .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.

# Options

# description

A custom description of the current page.

description: This is a custom description for this page

# expanded

Determines whether this folder should be expanded in the tree navigation on initial page load. Default is false.

Set to true to expand the folder node in the navigation.

expanded: true

The expanded option only applies to folders when configured within an index.yml folder configuration file.

Setting expanded: true within the metadata of an .md page or the paired .yml file will be ignored.

# hidden

Hides the current page in the navigation and from the search results. Default is false.

Set to true to hide.

hidden: true

# icon

Custom icon for the navigation node of the current page. Default is null.

Options include using an Octicon name, Emoji shortcode, or <svg> element.

icon: rocket
Emoji shortcode
icon: ":rocket:"
SVG element
icon: "<svg>...</svg>

# label

Custom label for the navigation node for the current page. Default is null.

title: Custom label

# layout

The layout for the page. Default is default.

Supported values: default, central, page, and blog.

Layout Description
default The default layout for all .md pages. The page is added to the main navigation.
page Similar to default layout, but is not added to the main navigation.
central A page with no left or right sidebar columns.
blog A blog page layout. Blog pages are not added to the main navigation and include blog specific < Newer and Older > navigation buttons at the bottom of each blog page.
layout: page

# order

A custom stack order within the navigation.

Options can include:

  • A number such as 100 or -100
  • Any string value that will be slotted into the A -> Z alpha ordering of all navigation nodes
  • A SemVer value such as v2.0

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.


# Order by alpha

Order values by alpha.

a = higher z = lower


# Order by v{semver}

Order by semver with latest release at the top


Items prefixed with v and mixed with other alpha values would be grouped at the end of

layout: 100