illuaminate
illuaminate copied to clipboard
Generate documentation in markdown format
It would be helpful to have the documentation in markdown instead of HTML.
With markdown I can use it in static pages generators such as MkDocs and better customize the style.
Do you actually need the pure markdown (with no embedded HTML), or would it be sufficient to emit HTML without the main page template?
I have thought about a Markdown doc backend before, but it's never really been clear to me how to emit various structures without either using a lot of embedded HTML (which kinda defeats the point of markdown) or losing a lot of useful information.
To my use-case, embedded HTML shouldn't be a problem, source files are going to be in Lua anyway and iirc MkDocs supports it.
If it's not much work I would go with the latter, perhaps in the future a pure Markdown output could be implemented.
LDoc + LDoc2MkDocs might work for your use case