3 ms·

I'm interested to know the answer as well. I've used org mode in the past for literate programming and document generation, but I'm starting to think that gener

I'm interested to know the answer as well. I've used org mode in the past for literate programming and document generation, but I'm starting to think that generating docs from comments is also a good option. Adding a mechanism to publish the docs (maybe part of CI/CD?) would make maintenance way easier, it's something I would love to test out.

corysama 5y ago
I’ve been working on a tool to do this based on a simple Python file watcher, web server and https://casual-effects.com/markdeep/ https://casual-effects.com/markdeep/ It just turns regular code into markdown code blocks and /** comment contents pass through to the markdown —> HTML pipeline. A little JS websocket and you get an auto-updating preview from any editor to any browser every time you ctrl-s. Not much time to work on it lately. But, I’ll Show HN when I put it on Github.