Page configuration

Individual .md pages are configured using a YAML front matter block at the top of the file.

sample.md

---
label: Sample
layout: page
order: 100
---
# Sample

This is a sample page.

Separate .yml file

If you prefer to keep configuration out of the Markdown file, create a paired .yml file with the same base name:

sample.md

# Sample

This is a sample page.

sample.yml

label: Sample
layout: page
order: 100

If configuration exists in both the .md front matter and the .yml file, the front matter takes precedence and the .yml file is ignored entirely.

label

string

Custom label for the navigation node of this page.

label: Custom label

icon

string

Custom icon for this page’s navigation node. Accepts an Octicon name, emoji shortcode, inline <svg>, or path to an image file.

icon: rocket            # Octicon
icon: ":rocket:"        # emoji shortcode
icon: ../static/r.png   # image path

order

string | number

Controls the position of this page in the left sidebar navigation.

A higher positive number pushes the page higher in the navigation.
A negative number pushes the page lower.
An alpha string is ordered against other labels alphabetically.
A vSemVer value (e.g. v2.0) is ordered with newest at top.

order: 100    # near the top
order: -100   # near the bottom
order: beta   # alphabetical ordering
order: v2.0   # semantic version ordering

Priority	Type	Notes
Highest	Positive number	Larger = higher
—	Alpha string	Ordered against labels A→Z
—	No order set	Alphabetical by label/title/filename
—	Alpha string (low)	e.g. `zulu`
—	`vSemVer` (newer)	Grouped below alpha items
Lowest	Negative number	Smaller = lower

description

Set a custom meta description for the page using the meta object:

---
meta:
  description: "A concise description of this page for search engines."
---

This value is used for the <meta name="description">, og:description, and twitter:description tags.

visibility

string

default:"public"

Controls page visibility and password protection.

Mode	In nav	In search	Password required	Description
`public`	Yes	Yes	No	Normal public page
`hidden`	No	No	No	Accessible by direct URL; not shown in nav or search
`protected`	Yes	No	Yes	Shown in nav but requires a password
`private`	No	No	Yes	Hidden from nav and requires a password

---
visibility: hidden
---
# Draft Page

For protected and private pages, set the password with the --password flag or the RETYPE_PASSWORD environment variable:

retype build --password <your-password>

layout

string

default:"default"

The page layout to use.

Layout	Description
`default`	Standard layout with left sidebar navigation and right TOC. Added to main navigation.
`page`	Same as `default` but not added to main navigation.
`central`	No left or right sidebars.
`blog`	Blog layout with Newer/Older navigation. Not added to main navigation.

layout: central

author

string | list | object

The author or authors of this page. Also accepted as authors.

author: Frank

authors: [Frank, Annette Jones, steffen@example.com]

Full author objects support name, email, link, and avatar:

authors:
  - name: Frank Esposito
    email: frank@example.com
    link: https://twitter.com/frank
    avatar: https://example.com/frank.jpg
  - Annette Jones

date

string

Custom publish date for the page. Must be in yyyy-mm-dd or yyyy-mm-ddThh:mm format. Used to order blog pages (newest first).

date: 2024-06-15
date: 2024-06-15T09:00

created

string

Custom creation date for this page. Use this to record when content first went live, separate from any subsequent edits tracked by lastUpdated.

created: 2024-05-14

lastUpdated

string | object

Controls the last updated footer metadata for this page. Overrides the project-level setting for this page.Simple string form — set a manual date:

lastUpdated: 2026-03-01

Object form — set both date and author manually:

lastUpdated:
  date: 2026-03-12
  by: Documentation Team

Git-backed form — configure automatic generation:

lastUpdated:
  date:
    enabled: true
    source: author     # or: committer
  by:
    enabled: true
    source: committer

Manual values and Git-backed values are not mixed on the same page. Setting either lastUpdated or lastUpdatedBy manually disables Git-backed generation for that page.

lastUpdatedBy

string

Shorthand to set only the author shown in the last updated footer. Equivalent to lastUpdated.by.

lastUpdated: 2026-03-12
lastUpdatedBy: Documentation Team

backlinks

Retype Pro only. Page-level backlink settings override project-level defaults.

backlinks.enabled

boolean

default:"true"

Enable or disable the “See also” backlinks section on this page.

backlinks:
  enabled: false

backlinks.title

string

default:"See also"

Custom heading above the backlinks section on this page.

backlinks.maxResults

number

default:"12"

Maximum number of backlinks to display on this page.

nav

Retype Pro only.

nav.badge

string | object

Add a badge to this page’s sidebar navigation item.

nav:
  badge: NEW           # simple text badge
  badge: NEW|info      # text with variant shorthand

Full object form:

nav:
  badge:
    text: BETA
    variant: warning
    icon: alert
    size: s

Supported badge properties: text, variant (primary, success, danger, warning, info, light, dark, ghost, contrast), size (xs–3xl), corners (round, square, pill), icon, iconAlign, link, target.

nav.mode

string

Retype Pro only. Set to stack to convert the folder containing this page to a stacked navigation layout.

nav:
  mode: stack

nextprev

Retype Pro only.

nextprev.mode

string

default:"show"

Controls the display of Next/Previous navigation buttons at the bottom of this page.

Option	Description
`show`	Show buttons and include page in sequence
`hide`	Hide buttons but keep page in sequence
`exclude`	Hide buttons and exclude page from sequence

nextprev:
  mode: exclude

permalink

string

A custom URL path for this page, overriding the path derived from the file location. Useful when migrating from another platform.

---
permalink: /tutorial/publish-to-github-pages/
---

When set on a folder’s index.md, readme.md, or index.yml, it becomes the base permalink for all pages in that folder.

redirect

string

Redirect requests for this page to another location (internal path or external URL).

---
redirect: getting-started.md
---

Retype also scans the project and replaces any links pointing to the old page with the redirect target.

target

string

Controls how navigation links to this page behave when clicked.

target: blank  # opens in a new tab

Retype automatically transforms blank → _blank, self → _self, etc.

image

string

Custom feature image for page summaries (used in blog listings, social cards, etc.). Accepts a local path or external URL.

image: ../static/feature-image1.jpg
image: https://example.com/feature.jpg

By default, Retype uses the first image found on the page.

Retype Pro only. Set to false to hide the breadcrumb navigation on this page.

breadcrumb: false

expanded

boolean

default:"false"

Expand this folder node in the tree navigation on initial page load. Only applicable when set in a folder’s index.yml or default page.

expanded: true

templating

boolean

default:"true"

Disable the Retype content templating engine on this specific page.

templating: false

Page configuration

Separate .yml file

label

icon

order

tags

category

description

visibility

layout

author

date

created

lastUpdated

lastUpdatedBy

toc

backlinks

nav

nextprev

permalink

redirect

target

image

expanded

templating

​Separate .yml file

​label

​icon

​order

​tags

​category

​description

​visibility

​layout

​author

​date

​created

​lastUpdated

​lastUpdatedBy

​toc

​backlinks

​nav

​nextprev

​permalink

​redirect

​target

​image

​breadcrumb

​expanded

​templating

Separate .yml file

label

icon

order

tags

category

description

visibility

layout

author

date

created

lastUpdated

lastUpdatedBy

toc

backlinks

nav

nextprev

permalink

redirect

target

image

breadcrumb

expanded

templating