Quick Start

From an empty content directory to a published page in five minutes.

On this page

1. Create a page

bash

hugo new docs/guides/my-first-guide.md

The archetype gives you the front matter Tartarus cares about:

yaml

---
title: My First Guide
description: ""
weight: 10
draft: true
---

Set draft: false when you want it published, and give it a weight — that is what orders the sidebar.

2. Write Markdown

## Install the thing

Run the installer:

    npm install the-thing

## Configure it

Add a `config.json` next to your entry point.

## and ### headings become the table of contents automatically. You never register a page anywhere: the sidebar, breadcrumb and previous/next links all read the content tree.

3. Group pages into a section

A directory with an _index.md becomes a collapsible sidebar group:

text

content/docs/
├── _index.md
└── guides/
    ├── _index.md          ← the group
    ├── deployment.md      ← weight: 10
    └── customization.md   ← weight: 20

yaml

---
title: Guides
description: Task-oriented walkthroughs.
weight: 30
---

4. Make it yours

Open hugo.toml and change the project name, repository and accent colour:

toml

[params]
  projectName = "Acme Docs"
  repository = "https://github.com/acme/docs"
  accentColor = "#0ea5e9"
  accentColorDark = "#7dd3fc"

5. Ship it

bash

pnpm build

Upload public/ anywhere that serves static files. See Deployment for platform-specific notes.

Tip

Press ⌘K (or CtrlK) to open search on any page. / works too.

Edit this page