Show HN: Rundmz – library for runnable Markdown for tutorials and demos

[adhocpotato]

I put together a library in Golang which lets you use Markdown in a literate programming style. Blockquotes and comments can specify associated actions, calling back into your Go code. This lets you create tutorials and scripts which can be viewed in a browser or run on the command line. We use this in the OpenZiti project (https://github.com/openziti/ziti) for our tutorials and demos. I thought others might be interested in using the code or even just the concept.

[ultrasaurus]

Fellow demo-enthusiast here :) It seems pretty cool, do you have a few non-Ziti examples to whet the appetite?

[adhocpotato]

Thinking about this some more: I tend to be a 'scratch your own itch' type person, and I haven't had a place where I needed this elsewhere. I think it would work pretty well think anything that was wrapping a series of commands with a specific tool. The first thing that came to mind was docker. I could put together an example for how to do something simple in docker, maybe following the steps in https://docs.docker.com/get-started/02_our_app/. If that sounds interesting, let me know.

[adhocpotato]

The only place I've used it so far is for Ziti stuff. I did add a (really tiny) example to the project itself to show how to structure it: https://github.com/openziti/runzmd/tree/main/example

That was one reason I left the ziti actions in the project, as I thought they'd be useful as real life examples for someone writing their own actions.