Docs
Configuration
Site settings, params, menus, data files, and deployment options.
Site configuration
A complete starting configuration. Put this in hugo.yaml or config/_default/hugo.yaml.
baseURL: https://example.com/
title: My Documentation
locale: en-US
theme: eldandocs
enableRobotsTXT: true
disableKinds:
- taxonomy
- term
- rss
mainSections:
- docs
- blog
params:
description: A short description used in meta tags.
homeTitle: a short phrase for the home page title
docsSection: docs
blogSection: blog
homeDocs: true
homeBlog: true
search: true
repo: https://example.com/repo
logo: images/logo.svg
favicon: favicon.svg
eldancssURL: https://eldancss.com/eldan.css
markup:
goldmark:
renderer:
unsafe: true
highlight:
noClasses: false
menus:
main:
- name: Docs
pageRef: /docs
weight: 10
- name: Blog
pageRef: /blog
weight: 20
footer:
- name: Getting started
pageRef: /docs/getting-started
weight: 10
baseURL = "https://example.com/"
title = "My Documentation"
locale = "en-US"
theme = "eldandocs"
enableRobotsTXT = true
disableKinds = ["taxonomy", "term", "rss"]
mainSections = ["docs", "blog"]
[params]
description = "A short description used in meta tags."
homeTitle = "a short phrase for the home page title"
docsSection = "docs"
blogSection = "blog"
homeDocs = true
homeBlog = true
search = true
repo = "https://example.com/repo"
logo = "images/logo.svg"
favicon = "favicon.svg"
eldancssURL = "https://eldancss.com/eldan.css"
[markup.goldmark.renderer]
unsafe = true
[markup.highlight]
noClasses = false
[[menu.main]]
name = "Docs"
pageRef = "/docs"
weight = 10
[[menu.main]]
name = "Blog"
pageRef = "/blog"
weight = 20
[[menu.footer]]
name = "Getting started"
pageRef = "/docs/getting-started"
weight = 10
disableKinds keeps empty taxonomy and RSS pages out of the build. mainSections should list your docs and blog sections so Hugo treats them as the site’s main content.
markup.goldmark.renderer.unsafe is required if your pages contain raw HTML, such as the demo page. markup.highlight.noClasses: false emits class-based Chroma markup, which the theme’s syntax colors and code tools expect.
Parameters
| Parameter | Default | Purpose |
|---|---|---|
description | empty | Site description used in meta tags and schema. |
homeTitle | tagline or site title | Phrase used in the home page title. |
tagline | empty | Fallback for homeTitle. |
docsSection | docs | Section used for the documentation sidebar and schema. |
blogSection | blog | Section used for the blog list and post metadata. |
homeDocs | true | Set to false to hide the docs section on the home page. |
homeBlog | true | Set to false to hide the blog section on the home page. |
search | true | Set to false to hide the search UI and skip the index. |
repo | empty | Adds a source link to the footer. |
logo | empty | Path to a header logo in static/. Defaults to the bundled assets/brand/eldan-mark.svg. |
favicon | favicon.svg | Path to the favicon in static/. |
eldancssURL | https://eldancss.com/eldan.css | EldanCSS URL fetched at build time. |
urlPrefix | empty | Prefix for internal links and assets behind a path-rewriting proxy. |
downloadBase | empty | Base URL prepended by the download-link shortcode. |
downloadVersion | empty | Explicit version used by versioned download links. |
downloadVersionFile | empty | File to read a version from, such as VERSION. |
downloadVersioned | false | true, false, or production for versioned download paths. |
changelogFile | empty | Keep a Changelog file used by the changelog shortcode instead of data/changelog.yaml. |
software | empty | Optional SoftwareApplication JSON-LD map for the home page. |
params:
description: A short description used in meta tags.
homeTitle: a short phrase for the home page title
docsSection: docs
blogSection: blog
homeDocs: true
homeBlog: true
search: true
[params]
description = "A short description used in meta tags."
homeTitle = "a short phrase for the home page title"
docsSection = "docs"
blogSection = "blog"
homeDocs = true
homeBlog = true
search = true
Menus
menus.main fills the header and menus.footer fills the footer. Use pageRef for internal pages and url for external links.
menus:
main:
- name: Docs
pageRef: /docs
weight: 10
- name: Blog
pageRef: /blog
weight: 20
footer:
- name: Getting started
pageRef: /docs/getting-started
weight: 10
[[menu.main]]
name = "Docs"
pageRef = "/docs"
weight = 10
[[menu.main]]
name = "Blog"
pageRef = "/blog"
weight = 20
[[menu.footer]]
name = "Getting started"
pageRef = "/docs/getting-started"
weight = 10
Home sections
The home page lists documentation pages by weight, followed by recent blog posts. Either section is omitted when its section has no pages, and homeDocs: false or homeBlog: false hides it explicitly. Pages with hideFromHome: true are skipped.
Titles and eyebrows come from data/home.yaml. All keys are optional:
| Key | Purpose |
|---|---|
eyebrow, title, lead | Hero copy. |
actions | Buttons with label, url, and optional class. |
code | Markdown source shown in the code card and rendered below it. |
code_label, preview_label | Labels above the source and preview. |
docs_eyebrow, docs_title | Heading for the docs list. |
blog_eyebrow, blog_title | Heading for the blog list. |
features_eyebrow, features_title | Heading above the feature cards. |
cards | Feature cards with title and text. |
For example:
# data/home.yaml
eyebrow: Hugo documentation theme
title: Docs and notes, quietly styled.
lead: A short introduction to the project.
actions:
- label: Get started
url: /docs/getting-started/
class: docs-button--primary
docs_eyebrow: Docs
docs_title: Start here
blog_eyebrow: Blog
blog_title: Recent posts
cards:
- title: Write Markdown
text: Sidebars, tables of contents, and search are wired for you.
Labels
All user-facing labels live in data/strings.yaml. Copy that file into your site and change only the keys you need; Hugo merges the two maps and your values win.
# data/strings.yaml
skip: Skip to content
search:
label: Search
placeholder: Search docs and posts
hint: Up/Down to navigate, Enter to open, Esc to close
docs:
nav: Documentation
toc: On this page
previous: Previous
next: Next
blog:
min_read: min read
Downloads and changelog
download-link takes a file, an optional version, and an optional download attribute. Set downloadBase to the folder that contains the files. When downloadVersionFile is set, its contents are inserted as the version; downloadVersioned: production only does that for production builds.
changelog renders data/changelog.yaml by default:
- version: 0.1.0
date: 2026-11-18
notes:
- Initial release.
Set changelogFile: CHANGELOG.md to render a Keep a Changelog file instead.
Home page schema
The home page always emits WebSite JSON-LD. Add params.software to emit a SoftwareApplication entry as well:
params:
software:
name: My Project
version: 1.0.0
license: https://opensource.org/license/0bsd
downloadUrl: https://example.com/downloads/app.css
category: DeveloperApplication
operatingSystem: Any
EldanCSS
The core stylesheet is not stored in this theme. Hugo fetches it from eldancssURL during the build, then fingerprints and serves the result. Point that parameter at a versioned copy if you need a stable build. The first build needs network access.
The theme owns only the documentation chrome in assets/css/eldandocs.css. htmx, htmx fragments, and the htmx companion stylesheet belong to the EldanCSS site or another site-level integration.
Hosting
Set baseURL to the final deployed URL. If the site lives in a subdirectory, include that subdirectory in baseURL; internal links and assets use Hugo’s relURL, so they follow it automatically.
Proxied previews
If you serve the site through a path-rewriting proxy, set params.urlPrefix to the public prefix, e.g. /proxy/1314. The theme applies it to internal links, assets, and the search index. Leave it empty for normal hosting. This can be useful if your development environment is browser-based, such as code-server
.
Visual tokens
Color, type, spacing, and radius are controlled by EldanCSS tokens. See Customization for the live hue, saturation, and font controls.