Doc gen HTML fancification - Githubissues

SquidDev / illuaminate

Very WIP static analysis for Lua

https://squiddev.cc/illuaminate/

BSD 3-Clause "New" or "Revised" License

49 stars 2 forks source link

Doc gen HTML fancification #18

Closed SquidDev closed 2 years ago

SquidDev commented 4 years ago

The current website generated by illuaminate is a little sparse at times. There's a couple of things which are probably worth doing:

General aesthetics:

[x] Collapsible sidebar. (96c8c58ab3b6e9d1524f6f8e61d3c50bb4cf87d6)
[x] Table of contents for the current page in the sidebar.
[x] Split the module list on the index into categories. (f98520cc070b9292409c6908dea2e58065f2300b)

Building

[x] Bundle CSS and JS (if needed) with illuaminate, with option to append an additional file.
[x] Append a cache buster to HTML.

Interactive elements

[ ] Search documentation. I played a little bit with lunr and wasn't especially impressed, so need to do some more research/testing here.
[x] Link known references within examples.