Skip to content
chiltepin
chiltepin docs
Getting started

Your first doc

Write a sequence diagram in Markdown, validate it with Chiltepin, and export a standalone HTML page.

Complete installation, then create docs/orders.md. Copy the YAML from the example below into a fenced sequence block, under a ## Request flow heading. The fence type chooses the renderer; the YAML supplies its content.

What a block looks like

Edit the source below to try the renderer in your browser. These edits do not change your local file.

```sequenceeditable · live
renderedchiltepin renders this
SECTION 01 · Sequence
SEQUENCE·POST/orders
Sequence diagram: /orders, 2 messages between 2 actorsClientOrders API1POST /orders2201 Created
Legendcallresponsethe answer the caller getsactive
Valid — passes chiltepin check

The heading above a block becomes its title. The optional id lets another block reference it. Put explanations and decisions in plain Markdown around the block.

The everyday loop

Save your file, then run:

npx chiltepin check docs/orders.md
npx chiltepin html docs/orders.md -p

Fix any validation errors before exporting. Warnings do not fail the command by default. A successful check confirms the structure and references; review whether the diagram accurately describes your system.

Look up fields before adding another block:

npx chiltepin block sequence

Next steps