Documentation
What hugodoks is, and how this site is organized.
hugodoks is a documentation theme for Hugo built on Pico CSS v2. It renders the classic three-column docs layout — a collapsible navigation sidebar on the left, the article in the center, an “On this page” table of contents on the right — plus client-side search, dark and light themes, and a set of docs-oriented shortcodes.
There is no Node.js and no build pipeline: styles and scripts are bundled with Hugo’s native asset pipeline, and all assets are vendored so a site builds fully offline. The site you’re reading is the theme’s own exampleSite — everything shown here ships in the box.
How this site is organized
Pages under content/docs/ form the documentation tree you see in the left sidebar:
- Ordering —
weightin front matter sorts pages and sections in the sidebar and the prev/next pager. - Sections — a directory with
_index.mdbecomes a collapsible group in the sidebar (like Shortcodes) and renders its children as icon cards. - Table of contents —
toc: trueenables the right-hand TOC, built fromh2/h3headings. - Descriptions and icons —
descriptionfeeds section cards and meta tags;icontakes any Phosphor icon name for the sidebar and cards — see Icons.
Status
hugodoks is pre-1.0: the docs layout, landing sections, search and shortcodes work and are covered by integration tests, but template and parameter names may still change between minor releases.
Install hugodoks in a new Hugo project and publish your first docs page.
ConfigurationSite params, menus and build settings hugodoks understands.
Landing pageCompose the home page from data/landing.yaml — no templates needed.
FeaturesNavigation, search, table of contents, themes and every other built-in.
GuidesTask-oriented walkthroughs for common docs setups.
ShortcodesDocs-oriented shortcodes that ship with hugodoks, each with a live demo.