Content

How Markdown files map to pages, sections and navigation.

On this page

The content tree

Everything under content/docs becomes documentation. Directories become sections, Markdown files become pages, and the whole tree drives the sidebar.

text

content/
└── docs/
    ├── _index.md            → /docs/
    ├── getting-started/
    │   ├── _index.md        → /docs/getting-started/
    │   └── installation.md  → /docs/getting-started/installation/
    ├── concepts/
    ├── guides/
    └── reference/

A directory without an _index.md still renders, but it has no description and no overview page — always add one.

Front matter

Only four fields matter:

yaml

---
title: Installation
description: Install and configure Tartarus.
weight: 20
draft: false
---

Field	Effect
`title`	Page heading, `<title>`, sidebar label, search result title
`description`	Subtitle under the heading, meta description, card text
`weight`	Ordering in the sidebar and in previous/next
`draft`	Excluded from production builds

Two optional fields are supported:

Field	Effect
`linkTitle`	Shorter label used in navigation when `title` is long
`toc`	Set to `false` to hide the table of contents on that page

Weights are per level

weight orders siblings only. A page with weight: 10 inside Guides is not compared against pages in Reference — sections carry their own weight in their _index.md.

Reading order

Previous/next links follow the same order as the sidebar: depth-first through the tree, sorted by weight at each level. Add a page in the middle and the surrounding links update on the next build.

Assets next to content

Images placed beside a page are page resources and can be referenced relatively:

![Architecture diagram](diagram.png)

The image render hook resolves the file, adds loading="lazy" and applies the site's border and radius.

Edit this page