Source for the cetrafs documentation site, built with Hugo
and a custom in-repo theme (themes/cetrafs/). No Node, no build step beyond Hugo.
- Hugo extended v0.158 or newer (the config uses
locale). CI pins 0.168.0.
hugo server -D # http://localhost:1313/hugo --minify # output in public/ (git-ignored)Content follows the Diátaxis framework:
content/
_index.md # homepage (layout: themes/cetrafs/layouts/index.html)
docs/
_index.md # /docs/ landing page
intro/ (w=5) # what cetrafs is, project status
tutorials/ (w=200) # learning-oriented: loop device -> two nodes -> Proxmox
how-tos/ (w=300) # task-oriented recipes
concepts/ (w=400) # understanding-oriented explanation
reference/ (w=500) # tools, mount options, procfs, params, limits, format
themes/cetrafs/
layouts/ # baseof, single/list (shared partials/doc-page.html), home, 404
layouts/partials/ # topbar, sidebar, toc, breadcrumbs, doc-kind badge, prev/next, brand mark
layouts/shortcodes/ # callout, steps, version, plugin-version
assets/css/main.css # the whole design system (CSS custom properties, light/dark)
assets/js/ # client-side search, copy-code button
static/ # fonts, favicons, logo SVG, social card
A page's Diátaxis badge (Tutorial / How-to / Explanation / Reference) is derived from its top-level section automatically.
---
title: "Page title"
description: "One line, used in search results, section cards and SEO."
weight: 345 # order within the section; check siblings
toc: true
---Shortcodes:
{{< callout type="note|tip|warning|danger" title="Optional" >}}Markdown{{< /callout >}}
{{< steps >}}1. numbered steps rendered as badges{{< /steps >}}
{{< version >}} the current cetrafs release, from params.version in hugo.toml
{{< plugin-version >}} the current cetrafs-proxmox release, from params.pluginVersion
Never hardcode a release number in content: use {{< version >}} or
{{< plugin-version >}} (both work inside code blocks). Templates use
.Site.Params.version and .Site.Params.pluginVersion.
The search index (/index.json) and section cards are generated automatically.
The content is derived from the cetrafs source tree (docs/*.md, include/cetrafs.h,
kmod/procfs.c, the tools' usage text). When those disagree, the code wins.
Things worth re-checking on each release: the versions in hugo.toml
(params.version for cetrafs, params.pluginVersion for cetrafs-proxmox), supported kernels, procfs fields, module parameters, and
mkfs defaults.
The logo and favicons come from the cetrafs-brand repository. The favicons,
the web manifest icons and logo/*.svg in themes/cetrafs/static/ are copies of
its web/ and logo/ files. partials/brand-mark.html inlines the mark
(logo/icon-rounded.svg, or the simplified web/favicon.svg below 24 px) with
its colours taken from --mark-tile and --mark-line. Brand navy is #011346,
and the site palette is built on it.
The site is published at https://cetrafs.com/ (baseURL in hugo.toml).
The repository has two remotes, kept in sync: origin (GitLab) and gh
(GitHub, cetrafs/cetrafs.github.io). A push to gh/main publishes the
site: .github/workflows/deploy.yml builds it and deploys it to GitHub Pages.
The custom domain is set in the GitHub repository's Pages settings (CNAME).
On GitLab, .gitlab-ci.yml only checks that the site builds.
Both pipelines clone with full history, because each page's "last updated" date
comes from git (enableGitInfo).
Documentation (content/): CC BY 4.0. Website code: MIT (LICENSE). Fonts:
SIL OFL 1.1. Details in LICENSE-docs.md. cetrafs itself:
kernel module GPL-2.0-or-later, tools AGPL-3.0-or-later or commercial.