Skip to content

[Feature Request]: Numbered steps #1074

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
2 tasks done
theletterf opened this issue Apr 10, 2025 · 2 comments · Fixed by #1092
Closed
2 tasks done

[Feature Request]: Numbered steps #1074

theletterf opened this issue Apr 10, 2025 · 2 comments · Fixed by #1092

Comments

@theletterf
Copy link
Contributor

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
@theletterf
Copy link
Contributor Author

+CC @bmorelli25 @alaudazzi

@reakaleek
Copy link
Member

Related discussion: #754

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants