hextra icon indicating copy to clipboard operation
hextra copied to clipboard

Add tree/directory layout for documentation

Open simchev opened this issue 9 months ago • 1 comments

Feature Description

The idea is to be able to document a directory structure, whether it's an OS directory, or any kind of deeply nested tree structure.

Problem/Solution

The basic nav bar starts to get messy at depths of 4+. If you need to document any deeply nested structure, it gets really hard to navigate.

I propose we add a new layout type of "tree" or "directory", which would be a specific kind of /docs where we show a navigable tree at the top, and it shows the content based on your navigation in that tree.

Alternatives Considered

No satisfying alternatives other than splitting, but it defeats the purpose.

simchev avatar Mar 29 '25 01:03 simchev

@simchev hey, can you show me some examples?

personally, I think sidebar navigation isn’t ideal for deeply nested structures (like the 4+ you mentioned). That said, you could implement a custom "tree" shortcode or template and embed it into the theme where needed. That might be a more flexible approach than wait for a theme level solution from my end.

imfing avatar Mar 29 '25 10:03 imfing