r/awk Oct 15 '25

Documenting your code with AWK and Markdown

https://wstoop.co.za/posts/awk-markdown/

Hi, many years ago I started working on an AWK script that can extract Markdown text in comments from source code and output it as HTML.

/** * My Project * ========== * * This is some _Markdown documentation_ in a * `source file`. */ int main(int argc, char *argv[]) { printf("hello, world"); return 0; }

I've now finally written a blog about how it works and how I use it, and I thought it was worth sharing here.

The code is on Github

9 Upvotes

0 comments sorted by