dtwrks / elm-book

Rich documentation builder for Elm applications and packages. Inspired by Storybook and HexDocs.
http://elm-book-in-elm-book.netlify.app
Mozilla Public License 2.0
96 stars 8 forks source link

Possibility for chapter nesting #40

Open jamesrweb opened 1 year ago

jamesrweb commented 1 year ago

I would love to use elm-book for a documentation site I am currently planning out but I see no way to deeply nest chapters currently. For example, imagine a sidebar like so for example:

| Getting Started (Group)
| -> Introduction (Chapter)
| -> Key Concepts (Chapter)
| Guides (Group)
| -> Javascript (Group)
| -> -> Installation (Chapter)
| -> -> Basic Usage (Chapter)
| -> -> Reference Guide (Chapter)
| -> Typescript (Group)
| -> -> Installation (Chapter)
| -> -> Basic Usage (Chapter)
| -> -> Reference Guide (Chapter)
| -> PHP (Group)
| -> -> Installation (Chapter)
| -> -> Basic Usage (Chapter)
| -> -> Reference Guide (Chapter)

As things stand, it seems not possible to implement such nested groupings, is this understanding correct and if so, is it addressable or is there a reason why it isn't or shouldn't? For me it would definitely be a helpful thing to have the possibility of as the rest of the implementation works like a charm AFAICS so far for the use case.

georgesboris commented 1 year ago

@jamesrweb hey! thanks for opening this issue - this is currently not possible but you're right that nothing prevents it from happening on the design. I'm currently working on elm-book v2 and this should be a good thing to add to the features but I don't think it is something to be released in the next month or so (but not much longer than that!)

jamesrweb commented 1 year ago

I'm currently working on elm-book v2

Is there any kind of roadmap / feature set that is in stone for v2? Would be great to see whats upcoming if there is.

in the next month or so (but not much longer than that!)

So this is probably something you could have released in the next 2 - 3 months is what I take away from that, or have I misunderstood? šŸ˜„ (update: I did misunderstand but still šŸ¤·šŸ»)

@georgesboris looking forward either way! šŸš€

jamesrweb commented 5 months ago

@georgesboris did this ever get released or worked on? I don't believe it was from what I can see in my own elm-books. šŸ˜