4 devlogs
4h 3m 35s
A Markdown to HTML converter, geared towards documentation generation
(I wanted to work on my other project, GameLISP, but it’s borked until the website is fixed so, I guess, docgen work :-P)
There’s not much to talk, except that the project is undergoing a restructuring. Rather than one single .md file generating documentation, this will be a slightly more complete solution for projects. It will still, at its core, be a documentation-focused Markdown to HTML converter, but it will also be able to extract documentation from code comments!
It should be relatively simple to write a regex to match a wide variety of comment styles (I’m thinking users will also be able to write their own regexes) with the only problem coming to mind being strings like, for example, "// not a comment", which would get erroneously matched… I’m afraid the users will simply have to Deal With It.
As internal code redesigns are not very visual, have a code screenshot instead
0
Log in to leave a comment
Merry Christmas, and happy holidays! Added some more features, but today will probably be a slow day (busy eating turkey)
0
Log in to leave a comment
Further work! We can now parse bold text, italics, strikethrough, code blocks, lists, etc.
I’m thinking I’ll start figuring out some way to automatically generate documentation from the LISP code I’ll be writing for my other project, or some separate file containing function descriptions… Or maybe it’ll just all be markdown. Who knows!
0
Log in to leave a comment
Split this project from my main one, GameLISP. It’s a basic documentation generator which converts .md files to .html. Currently, headings are working, but the rest won’t be too difficult to do :-D
Here’s the TKinter frontend, and a side-by-side comparison of the original file and the generated one…
2
Log in to leave a comment
Comments
hey there! cool project! is it supposed to be a gui for generating the docs?
Thanks!!! Yes, the GUI is part of it, though the main part is really the doc generator, so I’m not putting a lot of effort into it, haha