Include static pluto/jupyter/marimo notebook in Documenter output

General Usage
, , ,
1

Is there some nice way to include any type of notebook, or even just raw HTML, in documentation generated by Documenter?

I have several notebooks of sympy calculations that I use to verify lots of formulas in my code. I’d like to publish these somehow alongside my documentation so that users can look them up. In my python documentation, I just use mkdocs-jupyter, which does all the work for me. A similar solution in Julia would be ideal, though I’m sure it wouldn’t be too hard to add some automation to convert my notebooks to HTML or something.

2

With pluto notebooks, you can use PlutoSliderServer.jl to render the notebook to html, and include this into a documenter page using an iframe. In this case, active javascript content stays active.

Alternatively, you can use PlutoStaticHTML.jl to generate documenter compatible html.

I have a package managing this: GitHub - j-fu/ExampleJuggler.jl: Help to maintain Julia code examples for Documenter and CI . I

3 Likes