Documentation on hugodoks

Getting started

Mon, 01 Jan 0001 00:00:00 +0000

This guide takes a brand-new Hugo project to a running documentation site in a few minutes.

Requirements

Hugo Extended >= 0.154.0 — check with hugo version. The theme needs the extended edition for its asset pipeline.
Git and Go — only if you install the theme as a Hugo module (recommended below).

Info

No Hugo installed? The theme repository itself is dockerized — inside a clone of hugodoks, make serve runs this site at http://localhost:1313 with the hugomods/hugo:exts image and nothing installed locally.

1. Create a site

hugo new site my-docs
cd my-docs

2. Add the theme

Initialize the site as a Go module, then import the theme in hugo.toml:

Configuration

Mon, 01 Jan 0001 00:00:00 +0000

Everything below goes in your site’s hugo.toml (or the YAML/JSON equivalent). The complete working example is this site’s own hugo.toml.

Required build settings

[outputs]
 home = ["html", "rss", "searchindex"]

[markup.highlight]
 noClasses = false

outputs.home — Hugo does not merge outputs from a theme. searchindex emits /index.json, the data source for the search modal; rss enables the RSS feed linked in <head>. Omit searchindex and the search trigger quietly does nothing.
markup.highlight.noClasses = false — makes Chroma emit CSS classes so the theme’s light/dark-scoped code stylesheets apply. With the default true, every code block is frozen to inline Monokai colors.

Site params

Param	Default	Purpose
`params.description`	—	Fallback `<meta name="description">` for pages without their own `description`
`params.docs.navRoot`	`/docs`	Section used as the root of the left sidebar nav
`params.docs.navDefaultIcon`	`dot`	Fallback sidebar icon for pages without `icon` in front matter (`""` renders an empty slot)
`params.docs.editPage`	`false`	Show an “Edit this page” link under each docs article
`params.docs.lastMod`	`false`	Show a “Last updated” line (Git date when `enableGitInfo` is on)
`params.docs.repoURL`	—	Repository base URL for the edit link (GitHub, GitLab and Bitbucket layouts are detected)
`params.docs.repoBranch`	`main`	Branch used in edit links
`params.docs.repoContentDir`	`content`	Directory inside the repo that holds content files
`params.docs.aiAssist`	`false`	Show an “Ask AI” dropdown in docs article headers with prefilled ChatGPT/Claude links to the page
`params.docs.aiAssistIcon`	—	Icon in the dropdown button: a Phosphor name (e.g. `sparkle`)
`params.docs.aiAssistLabel`	“Ask AI”	Text of the dropdown button
`params.brand.icon`	—	Optional icon next to the site title: a Phosphor name (e.g. `book`) or a path to an `.svg` in `assets/`
`params.footer.copyright`	—	Footer line, rendered as Markdown
`params.social.github`	—	`owner/repo` shown on the home page

Example:

Landing page

Mon, 01 Jan 0001 00:00:00 +0000

The home page is assembled from sections declared in data/landing.yaml. Each section picks a partial via template, is toggled with enable, and ordered by weight:

sections:
 hero:
 enable: true
 weight: 10
 template: hero
 # …section-specific fields

Delete the file — or set every enable: false — and the home page falls back to rendering content/_index.md as a plain article.

Hero

A badge, a title, a Markdown subtitle, a row of call-to-action buttons and an info line:

Features

Mon, 01 Jan 0001 00:00:00 +0000

A tour of what hugodoks renders for every docs site, and the switches that control it.

Pages under params.docs.navRoot (default /docs) become the left sidebar:

Leaf pages and sections sort by weight; a page’s icon shows next to its title. Pages without one get a fallback marker — params.docs.navDefaultIcon (default dot; set "" for an empty slot).
Directories with _index.md render as collapsible <details> groups that auto-open on the active page. The section title links to its _index page; the caret toggles the group. Sibling groups stay open independently, like a file browser, and each group’s open state persists in localStorage across page loads.
The current page is highlighted and marked aria-current="page".
Below 768px the sidebar becomes an off-canvas drawer opened by the header’s hamburger button.

With toc: true in front matter, a sticky “On this page” aside is built from the page’s h2–h3 headings (configure the range with markup.tableOfContents.startLevel/endLevel). The toggle button collapses it and remembers the choice across pages via localStorage.

Documentation on hugodoks

Getting started

Requirements

1. Create a site

2. Add the theme

Configuration

Required build settings

Site params

Landing page

Hero

Features

Sidebar navigation

Table of contents

Documentation on hugodoks

Getting started

Requirements#

1. Create a site#

2. Add the theme#

Configuration

Required build settings#

Site params#

Landing page

Hero#

Features

Sidebar navigation#

Table of contents#

Requirements

1. Create a site

2. Add the theme

Required build settings

Site params

Hero

Sidebar navigation

Table of contents