Generate documentation in markdown format #40

Activity

1. SquidDev

   added

   enhancementNew feature or requestNew feature or request

   on Mar 21, 2023
2. SquidDev commented on Mar 21, 2023

   

   SquidDev

   on Mar 21, 2023

   Owner

   More actions

   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.
3. Ale32bit commented on Mar 22, 2023

   

   Ale32bit

   on Mar 22, 2023

   Author

   More actions

   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.
4. Commandcracker commented on May 14, 2023

   

   Commandcracker

   on May 14, 2023

   Last edited by Commandcracker

   More actions

   LDoc + LDoc2MkDocs
   might work for your use case