Configuration Reference
Every parameter Tartarus reads from hugo.toml.
On this page
Identity
| Parameter | Default | Description |
|---|---|---|
projectName | site title | Shown in the navbar, drawer and metadata |
description | — | Fallback meta description |
tagline | — | Home page subtitle |
logo | built-in mark | Path in assets/ or static/ |
favicon | favicon.svg | Path in static/ |
ogImage | — | Social share image |
Theme
| Parameter | Default | Description |
|---|---|---|
defaultTheme | system | light, dark or system |
accentColor | #6a4cff | Accent in light mode |
accentColorDark | #a690ff | Accent in dark mode |
Repository
| Parameter | Default | Description |
|---|---|---|
repository | — | Repository URL; also enables edit links |
repositoryBranch | main | Branch used in edit links |
docsPath | content | Repo-relative path to the content directory |
showEditLink | true | Show "Edit this page" |
Page chrome
| Parameter | Default | Description |
|---|---|---|
showBreadcrumb | true | Breadcrumb above the page title |
showPrevNext | true | Previous/next links |
showToc | true | Table of contents |
showLastModified | false | "Last updated" line — see the note below |
sidebarCollapseDepth | 2 | Sidebar levels expanded by default |
showLastModified has two prerequisites
The date comes from .Lastmod, and turning the parameter on is not enough. You
also need enableGitInfo = true, and a build that can see the full git
history.
Both failures are quiet — the build succeeds either way:
| Build | Result |
|---|---|
enableGitInfo off, or no git repository | No dates at all; Tartarus warns once at build time |
Shallow clone (fetch-depth: 1, the actions/checkout default) | Every page gets the same date — the one fetched commit — and nothing warns |
Full history (fetch-depth: 0) | Each page gets its own last-commit date |
Only the first case is detectable from inside a template, so CI must use
fetch-depth: 0. The included workflow already does.
Search
toml
[params.search]
enable = true
placeholder = "Search documentation..."
maxResults = 12Footer
toml
[params.footer]
enable = true
text = "Built with Hugo."
copyright = "Acme Inc."Social links
toml
[[params.social]]
name = "GitHub"
icon = "github" # a file in layouts/partials/icons/
url = "https://github.com/acme/docs"
navbar = true # also render it in the navbarMarkup
Tartarus expects these Hugo settings; change them only if you know why.
toml
[markup.goldmark.renderer]
unsafe = true # raw HTML in Markdown
[markup.highlight]
noClasses = false # class-based colours, themable
[markup.tableOfContents]
startLevel = 2
endLevel = 3Per-page front matter
| Field | Effect |
|---|---|
title | Heading, <title>, sidebar label |
linkTitle | Shorter navigation label |
description | Subtitle and meta description |
weight | Sidebar and prev/next ordering |
toc | false hides the table of contents |
draft | Excluded from production builds |