Skip to content
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

Using starlight's Steps for ordered lists #196

Open
gikf opened this issue Jun 29, 2024 · 0 comments
Open

Using starlight's Steps for ordered lists #196

gikf opened this issue Jun 29, 2024 · 0 comments

Comments

@gikf
Copy link
Member

gikf commented Jun 29, 2024

Multiple pages in documentation contain numbered lists, in a steps to follow manner. These can be a bit overwhelming with many list items, or when individual items have lots of text. Other than line starting with number there isn't much visual separation between steps and they can blend together a bit.

Starlight has Steps giving numbered list styling, clearly separating steps and step text.

Usage is not complicated:

  • Renaming *.md to *.mdx.
  • Importing Steps in the markdown.
  • Wrapping list in the <Steps></Steps> tags.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Backlog
Development

No branches or pull requests

1 participant