Skip to content
docs-sitekit

Menu

Type to search the docs.

↑ ↓ move · Enter open · Esc close

Options by topic

The same keys as the configuration reference, sorted by what you want to do, each with an example you can paste.

The reference is the one place where each key is documented: its type, its default, the values it accepts and its description. These pages do not repeat it. They show a group of keys together in a sitekit.config.json, and say what the group changes on the site.

Every example on these pages is a complete sitekit.config.json for the keys it shows, and a test checks it against the real schema. Another test reads the schema and fails when a key has no example here, so a new key cannot ship without one.

The topics

I want to…KeysPage
Name the site and shape the home pagesite, hero, features, statsIdentity and the home page
Set the menu, the footer, the collections and filesnav, footer, collections, sourcesNavigation and collections
Choose the first theme a visitor seesthemeTheme and design
Turn search and llms.txt on or offsearch, llmsSearch and llms.txt
Decide what blocks a publish, and what is kept outcheck, anonymize, vars, deployContent checks and publishing
Show an edit link and the date of the last changeeditLink, lastUpdatedEdit link and dates
Use a brand logo as an iconfeatures[].iconBrand logos

How the examples were checked

What each page says a key changes comes from building a site with that key and reading the result: the HTML of the pages, the files next to them, and the output of sitekit check. A sentence that starts with a path, a tag or a message is what was found there. Where a key only has an effect with another one, the page says so.

Edit this page

Last updated