Docs

How to build documentation with Vitrine, from installing it to examples that run on the page.

Vitrine is a theme for Hugo (opens in a new tab), the static site generator. You write pages in Markdown, Hugo turns them into a website, and Vitrine decides how that website looks and works: the tabs, the sidebar, code blocks, live examples and the rest.

These docs are built with Vitrine itself. If you’re new, start with Getting started. The reference lists every setting, front matter key and shortcode in one place.

In this section

• Getting started · From an empty folder to a running docs site.
• Writing · Pages, navigation, and what Markdown can do in Vitrine.
• Live examples · Examples that run on the page, with their files shown below them exactly as they run.
• Reference · Every setting, front matter key and shortcode in one place.
• Guides · Making Vitrine your own, putting the site online, and what's planned.