Menu
Get si

Books

A reference with chapters, figures and tables numbered for you, an index, a glossary and one printable volume.

A book is a folder whose _nav.md says type: book: chapters become numbered, figures and tables get numbers you can cross-reference, ((term)) builds the index, and the whole book prints as one volume.

Live#

bookThe Northwind Operations ReferenceHow an order moves through the stations, what breaks it, and how each break is repaired.
  1. Preface
  2. 1The order journey
  3. 2Promises and clocks
  4. 3Payments that time out
  5. AGlossary
4 chapters

Open the whole example

The Markdown behind it#

examples/book/01-journey.md:

markdown
---
description: The five stations an order passes, and who owns each one.
---

# The order journey

## Five stations

An order passes five stations in a fixed order: ((checkout)), ((payment)),
((warehouse)), ((courier)) and ((tracking)). [](#fig-the-five-stations-from-checkout-to-the-door)
shows them, and [](#tbl-who-owns-each-station) names their owners.

![The order journey](images/stations.svg "The five stations, from checkout to the door")

| Station | Owner | Answers within |
|---|---|---|
| Checkout | Web team | 300 ms |
| Payment | Payments team | 15 s (the bank's limit) |
| Warehouse | Operations | the next pick wave |
| Courier | Logistics partner | the route's departure |

Table: Who owns each station

## Hand-offs

A station hands the order on by writing an event; the next station reads it.
No station calls another directly, so a slow station never slows the one
before it. The (((events, hand-off))) events are kept for thirty days.

## What the customer sees

The ((tracking)) page reads the same events. It shows one tile per station and
the promise under them; see [](02-promises.md#the-promise-tile).

Key options#

Write What it does
type: book in _nav.md: chapters, numbering, a cover
((term)) an index entry
[](#fig-…) a numbered cross-reference
a-glossary.md appendices with letters

Commands#

Shell
si new manual --type book
si play manual/ --open
si build manual/ --pdf

The rules#