Clever Cloud documentation

The Clever Cloud documentation site uses Hugo and the Hextra theme. It provides responsive navigation, dark mode, and full-text search, and supports the following content features:

• Diagrams
• LaTeX mathematical notation
• Markdown
• Shortcode support
• Syntax highlighting

Published documentation

• Clever Cloud documentation
• API reference
• Clever Tools CLI reference
• Environment variables reference
• Guides and tutorials
• Platform changelog
• Technical documentation

The documentation is also available in the llms.txt format.

Repository structure

• archetypes/: templates for new guides, documentation pages, and application runtime pages
• content/: the site content
  • api/: API reference
  • changelog/: platform updates, one folder per year
  • doc/: technical documentation
  • guides/: deployment guides, one folder per section, such as frameworks/ or self-hosted/
  • postmortem/: incident reports
  • shared/: blocks that several pages include, never published on their own
• contributing/: the style guide and the authoring guide, which CONTRIBUTING.md introduces
• data/: structured data, such as runtime versions, Kubernetes versions, and glossary terms
• layouts/: Hugo templates and shortcodes, including the Markdown and llms.txt outputs
• scripts/: maintenance scripts, such as the CLI reference generator and the offline internal link checker
• static/: images, fonts, and the favicon

Local development

Requirements

Install the following tools before building the site:

• Git
• Mise

Mise installs the commitlint, Go, Hugo Extended, markdownlint-cli2, Node.js, and Vale versions declared in mise.toml, which both the local build and the checks of a change use.

Preview the site

Clone the repository and start Hugo's development server:

git clone https://github.com/CleverCloud/documentation.git
cd documentation
mise install
hugo server

The site is available at http://localhost:1313 and refreshes when a file changes. See the hugo server documentation for its options.

Deploy on Clever Cloud

The site uses the Clever Cloud static runtime with the following environment variables:

CC_DISABLE_MISE="true"
CC_WEBROOT="public"
CC_STATIC_AUTOBUILD_OUTDIR="public/developers"
SERVER_ERROR_PAGE_404="developers/404.html"

CC_DISABLE_MISE stops Clever Cloud from installing the development tools because the static runtime manages its deployment tools. Configure the route so its path ends in /developers, which matches the base URL and output directory of the site.

Tip

Set CC_HUGO_VERSION to a supported version such as 0.167 to select the Hugo version used for deployment

Contribute

You can contribute by creating an issue or submitting a pull request. Before you submit a change, read the contributing guidelines, which explain how to check and submit it. They link to the style guide and the authoring guide. Coding agents also follow AGENTS.md.