Using Marimo for package documentation
Hey all, I'm pretty excited about this new framework!
I'm thinking of a way to build docs for my python package and I thought of trying something new - perhaps building an interactive documentation using marimo.
This will also allow me to communicate back and forth with an LLM like Claude. Jupyter notebooks don't allow that in a straightforward way.
I have a few questions:
1. Do you it's generally a good idea? in terms of usability, speed, ability to render in browsers and other things I haven't thought of?
2. If you think it's worth a try - what workflow would you suggest? using a generic documentation platform and just embed the pages in them?
Thanks in advance!
Gilad
3 Replies
This is totally doable - we do this for our own docs.
We use sphinx with markdown and wasm playground to achieve this
I see that most of your docs is not in marimo, but markdown. There are some snippets from marimo... I'm thinking of having all of my documentation in marimo 🙂
oh I see - I haven’t see anyone do that yet but that should be very possible.
You can definitely write them in marimo and then export to html via the CLI. I am sure we can improve some thing (like automatic cross linking) - but I don’t know yet what until we actually try