On this page
Configuration
Settings live in three places, from the whole site down to a single page:
clay.yamlReference of every setting in clay.yaml, with defaults and a complete example.Front MatterReference of every front matter field of pages, folders (index.md) and the start page, with defaults and examples.Environment VariablesOverride settings from clay.yaml at build time, for example in CI or for a staging site.
#The three places
The site: title, addresses, navbar links, versions and languages.
title: "My Project"
baseURL: "/my-project/"
siteURL: "https://my-org.github.io"
languages: ["en", "de"]A page or a folder: title, icon, description, order and layout.
---
title: Setup
icon: fa-solid fa-wrench
order: 2
---One build: a staging site, a fork, or a secret that does not belong in the repository.
#Which value wins
A value set further right replaces the one before it. Front matter belongs to a single page and never clashes with the others.
#Key ideas
- Everything has a default. A
clay.yamlwith just atitleand plain Markdown files make a working site. - Environment variables win. They override
clay.yamlfor one build, without changing the file. - Typos are reported. An unknown key in
clay.yamlis a warning in every build, see build checks. - You don’t have to edit YAML by hand.
clay editchanges settings and front matter and keeps your comments and formatting. See clay edit.