Menu
Get si

Tutorials and guides

A folder of pages with a sidebar, steps you can tick, a runbook of commands, and AsciiDoc pages next to Markdown ones.

A guide is a folder with a _nav.md: its list is the sidebar, every page gets a breadcrumb and a pager, and a ## Step 3: heading becomes a numbered step. Pages can be Markdown or AsciiDoc (.adoc); both feed the same renderer.

Live#

guideThe order journeyFollow order #4711 from checkout to the doorstep on a laptop, and break it on purpose twice.
  1. Introduction
  2. 1Install the lab
  3. 2Place an order
  4. 3Pay for the order
  5. 4A declined card
  6. 5A warehouse backlog
7 pages

Open the whole example

The Markdown behind it#

examples/guide/_nav.md:

markdown
---
title: The order journey
description: Follow order #4711 from checkout to the doorstep on a laptop, and break it on purpose twice.
author: Ada Lindqvist · Operations
version: v1.0
theme: studio
footer: Northwind Logistics engineering
year: 2026
copyright: Northwind Logistics
edit-url: https://github.com/felipeg48/simple-ideas/edit/main/examples/guide
---

- [Introduction](index.md)
- Getting started
  - [Install the lab](install.md)
- The happy path
  - [Place an order](happy/place.md)
  - [Pay for the order](happy/pay.md)
- When it breaks
  - [A declined card](breaks/declined.md)
  - [A warehouse backlog](breaks/backlog.md)
- [Reset the lab](reset.adoc)

Key options#

Write What it does
_nav.md the sidebar: a nested list of pages and sections
## Step 1: … numbered steps with a badge
_header.md _footer.md shared header and footer
.adoc pages AsciiDoc pages in the same guide

Commands#

Shell
si new tutorial --type guide
si play tutorial/ --open
si build tutorial/

The rules#