Search documentation...

Frontmatter Reference

Frontmatter is TOML-formatted metadata at the top of .vdx files.

Syntax

Frontmatter is enclosed in +++ markers:

+++
layout = "default"
title = "My Page Title"
+++

# Page Content Here

Required Fields

None. All fields are optional with sensible defaults.

Available Fields

layout

Specifies which layout template to use.

layout = "default"
Value Description
default Standard documentation layout with sidebar
landing Landing page layout (excluded from nav)
Custom Any layout file in layouts/ directory

Default value is "default" if not specified.

title

The page title, used in:

  • Browser tab (`<

title>`)

  • Navigation sidebar
  • SEO meta tags
title = "Getting Started"

If not specified, the filename is used as a fallback.

Future Fields

These fields are planned for future versions:

description

Page description for SEO.

description = "Learn how to install and configure Velt"

date

Publication date for blog posts.

date = 2024-01-15

draft

Mark page as draft (excluded from build).

draft = true

order

Custom ordering in navigation.

order = 1

Examples

Minimal page:

+++
title = "About"
+++

# About Us

Full documentation page:

+++
layout = "default"
title = "Installation Guide"
+++

# Installation Guide

Welcome to the installation guide...

Landing page:

+++
layout = "landing"
title = "Welcome to Velt"
+++

<Hero title="Build Fast" subtitle="Static sites with V" />