Hierarchical display of examples

lunarmodules / ldoc

LDoc is a LuaDoc-compatible documentation generator which can also process C extension source. Markdown may be optionally used to render comments, as well as integrated readme documentation and pretty-printed example files.

https://lunarmodules.github.io/ldoc/

Other

788 stars 173 forks source link

Hierarchical display of examples #10

Open rpavlik opened 12 years ago

rpavlik commented 12 years ago

I have examples organized into several directories, in increasing order of "difficulty." LDoc faithfully recurses through all of them, but just globally alphabetizes them. It would be nice if the directory structure were reproduced.

stevedonovan commented 12 years ago

The challenge here is to represent the hierarchical structure; presenting it would be relatively straightforward. The LDoc hierrarchy is pretty flat, projects/"modules"/"items"; examples are at the "modules" level. I will give this some thought, since it would be a useful feature.

alerque commented 1 year ago

Contributions welcome. I don't have a lot of time to develop this myself but am trying to keep up with facilitating PRs. As Steve said the module layout is pretty flat anyway, but I can see a case for topics being nested with more navigation than they are now.