illuaminate icon indicating copy to clipboard operation
illuaminate copied to clipboard

Generate documentation in markdown format

Open Ale32bit opened this issue 1 year ago • 3 comments

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.

Ale32bit avatar Mar 21 '23 20:03 Ale32bit

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.

SquidDev avatar Mar 21 '23 23:03 SquidDev

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.

Ale32bit avatar Mar 22 '23 06:03 Ale32bit

LDoc + LDoc2MkDocs might work for your use case

Commandcracker avatar May 14 '23 19:05 Commandcracker