Skip to content

New to Sumi? Read the introduction.

On this page

Steps#

Put {.steps} under an ordered list to draw it as a procedure: numbered markers joined by a line, with each step's first line as its heading.

1. Create a virtual environment

    ```sh
    python -m venv .venv
    ```

2. Install Sumi

    ```sh
    pip install mkdocs-sumi
    ```

3. Start the preview server

    Run `mkdocs serve` and open the address it prints.
{.steps}

Create a virtual environment
```
python -m venv .venv
```
Install Sumi
```
pip install mkdocs-sumi
```
Start the preview server

Run mkdocs serve and open the address it prints.

Short steps#

Steps do not need bodies:

Write
Preview
Publish

Guidelines#

Start each step with a verb.
Keep one action per step. If a step needs a list of its own, it is probably two steps.
Indent step content by four spaces so it stays inside the step.