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

Nested lists #24

Open
griffi-gh opened this issue Feb 19, 2024 · 1 comment
Open

Nested lists #24

griffi-gh opened this issue Feb 19, 2024 · 1 comment

Comments

@griffi-gh
Copy link

griffi-gh commented Feb 19, 2024

I am trying to add a nested list in my feature docs (for feature subsets)
example:

  • ...
  • builtin_font (enabled by default) — Enable the built-in font (ProggyTiny, adds 35kb to the executable)
  • builtin_elements (enabled by default) — Enable the built-in elements (Container, ProgressBar, etc.)
    • builtin_container — Enable only the Container component (which is essential for laying out other components)
  • ...

However, it appears that implementing nested lists is currently not possible, even with the use of hacky workarounds.
I think adding a - (or */extra #) before the feature doc comment should add two spaces before the generated list entry, creating a nested list.

## Enable the built-in font (ProggyTiny, adds 35kb to the executable)
builtin_font = []
## Enable the built-in elements (`Container`, `ProgressBar`, etc.)
builtin_elements = ["builtin_container"]
## - Enable only the `Container` component (which is essential for laying out other components)
builtin_container = []
@ogoffart
Copy link
Member

ogoffart commented Mar 6, 2024

Nice suggestion but I'm not sure how best to do that.

The way you suggest it might not work because it is already valid markdown and it would be confusing that the - is moving the indentation.

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

No branches or pull requests

2 participants