Settings
This section provides the definitive reference to all the settings in site.toml; see site settings for example usage.
Settings are defined as TOML 1 which uses the term table also called an object, map or dictionary. Language identifiers are Unicode Language Identfiers 2.
Minimum required settings are shown below:
= "en"
= "example.com"
If you do not have a host name yet use localhost as a placeholder value.
These are the settings that can be defined at the top-level of site.toml:
langThe default language (required)hostHost for the website (required)versionVersion for the project (optional semver)charsetCharacter encoding for pages (optional, defaultutf-8)iconPath to a favicon for the site (optional, defaultfavicon.ico)manifestPath to a PWA manifest (optional, defaultapp.webmanifest)local-domainOverride an inferred local domain name (optional)
For more settings see the relevant section:
- Authors
Define site authors
- Build
Configure the build
- Collections
Collections database
- Date
Custom date formats
- Extension
Change file extensions
- Feed
Feed generation
- Fluent
Support multiple languages
- Hook
Run external commands
- Link
Control link behavior
- Live Reload
Live reload behaviors
- Node
Map profile names to NODE_ENV
- Page
Define global template data
- Redirects
Create location redirects
- Repository
Repository information
- Robots
Set robots rules
- Sitemap
Sitemap generation
- Sync
Sync repository settings
- Syntax
Syntax highlight
- Test
Modify the test runner commands
- Workspace
Group related projects
TOML is a language well suited to configuration as it is easy to read, write and parse and supports comments unlike other alternatives such as JSON.
Languages must be identified using Unicode Language Identfiers.