Skip to content

[Feature Request]: Numbered steps #1074

@theletterf

Description

@theletterf

Prerequisites

  • I have searched existing issues to ensure this feature hasn't already been requested
  • I have tested using the latest version of docs-builder

What problem are you trying to solve?

A special directive that renders content in a progression of numbered steps. This is useful for visually indicating procedures, for example.

Image

Proposed Solution

Something like this. The directive would take all headings of the same level within the block and turn them into steps, the content within converted into the content of the step itself (nesting allowed).

::::: steps

## Heading that turns into step 1

Content

## Heading that turns into step 2

:::::

### Examples and Research

Mintlify and other SSGs have this, but it's a custom development in most cases. I developed it for Tinybird docs. Example: https://www.tinybird.co/docs/forward

### Alternative Solutions

_No response_

### Additional Context

_No response_

### How important is this feature to you?

Nice to have

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions