跳到正文
Sumi 中文文档已上线,部分页面暂为英文。阅读 Sumi 介绍
Sumi
本页目录

本页还没有翻译,下面是 English 版本。

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}
  1. Create a virtual environment

    python -m venv .venv
    
  2. Install Sumi

    pip install mkdocs-sumi
    
  3. Start the preview server

    Run mkdocs serve and open the address it prints.

Short steps#

Steps do not need bodies:

  1. Write
  2. Preview
  3. 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.
Esc
↵ 打开 ↑↓ 移动 Esc 关闭
键盘快捷键
Ctrl K /
打开搜索与命令面板
t
切换深色模式
[ ]
上一页 / 下一页
j k
上一个 / 下一个标题
?
显示本帮助