Literate Programming

[AaronDovTurkel]

HI 👋 ,
I would love to see a way to harness Rocket and maybe unifiedJS to produce source code as well as documentation similar to Donald Knuth's Literate Programming tool WEB. This could even be integrated into the web.dev platform in general.

[daKmoR]

hey 👋,

that sounds like a good idea 👍

what would we need for that? anything you can pick up - or we can pick up together? feel free to share some ideas - I totally open for crazy plans 😬

[AaronDovTurkel]

Hey @daKmoR,
I would imagine starting off with something simple like ganesha where each file is just a markdown file with a LS bridge for debugging. This way you can compile the entire source code into either documentation or AST.

[daKmoR]

hmm I'm not sure I understand what the end goal is 🤔

How will it be different to vs code notebooks?

Care to elaborate in more detail on which user problem it would solve? and what a typical user flow would look like.

PS: VS Code just released it markdown language server maybe something worth considering

[AaronDovTurkel]

I was thinking of a development workflow that would involve just writing markdown files with code snippets...
So for instance, if I were developing a React application, my components folder would consist of just markdown files with the javascript code in code blocks. The goal of integrating with UnifiedJS and/or Rocket would be to be able to compile that code already from the markdown file. Eventually, I can see the whole application just being a set of markdown files with a readily producible doc book to boot. I wonder if the Markdown server would help in this instance because we sort of need to parse the markdown for code blocks and compile the code blocks at the same time (if running in a watch mode for instance). Something like Eve .

[daKmoR]

Thanks for opening this discussion and for helping improve Rocket.

Rocket has been rebuilt from a clean slate for the new @rocket/js release. The implementation, docs, APIs, and project structure have changed substantially, so the old issue history no longer maps cleanly to the current codebase.

I’m closing this as part of the repository reset.

This is currently a soft launch: the package and docs are live, and we’re dogfooding the new version on real projects before doing a larger public relaunch.

If this discussion is still relevant with the new Rocket, please open a fresh discussion/issue against the current main branch with updated context.

Thanks again.