I’ve recently been drawn to the idea of literate programming. I like to collaborate with people about software design, game design, or really any kind of design. To bounce ideas off each other and get excited about the unlimited possibilities. Design is great because your imagination can run wild.
Unfortunately, the reality is that writing code is more akin to painting a canvas than it is to speaking wishes into existence.
What I am looking for is a merging of the two. Create a living design document that also holds all the nitty gritty details of the code.
My first attempt at this is a project I call Literate Snake
. It’s written using Org files and taking advantage of Org Mode’s ability to extract all the code from a single file using org-babel-tangle
, we can embed code chunks right into the design specs. This approach lets us do all our planning and coding in a single space.
I’m working on a way to get the org file back from this design document so it can be used to compile the program.
Maybe instead, embedded editors within the document could use github actions to compile the document, but how would that look in a static webpage?