marimo + quarto
🟢 🔵 🏝️
This repository provides a framework for integrating Quarto
with marimo
, enabling markdown documents to be executed in a marimo
environment, and reactive in page.
What?
First, aquaint yourself with the marimo
! One you’ve digested the basics, and maybe even written a few marimo
notebooks, start to consider the possibilities of exporting marimo
cells to be standalone, Web Assembly modules, embeddable anywhere.
That’s where Quarto comes in with the qmd
format.
qmd
is a markdown format that allows for the extraction and execution of code cells in a markdown document. It’s a great way to maintain readable documents exportable to a variety of formats, while still being able to execute code.
This page, and the marimo
tutorials in the sidebar are qmd
documents, to get a sense of what’s possible, look at their source.
Getting started
Write a qmd
document with {marimo}
cells.
For instance the following cell
```{marimo}print("remember that stdout is not shown")
= "Only outputs!"
result
result, ```
produces the following output:
We can make it editable:
```{marimo}#| editor: true
= "Change me" + ("!" * 3)
editor_result
editor_result, ```
but the default is to show the output only.
editor_result
in the previous cell: Change me!!!
Hold ctrl
to manually run a stale cell.
but how do I run this?
Use the repo and do some reading! This documentation is TODO.