marimo-md-export
A CLI tool that wraps marimo export, extracts rendered outputs from the HTML export, and injects them into the markdown export.
The result is a markdown document with tables (as GFM or HTML), console output, and other cell outputs, plus a sidecar assets directory for figures and the intermediate HTML notebook.
Quick start
Write your marimo .py notebook — cell outputs are rendered by default:
fig, ax = plt.subplots()
ax.plot(x, np.sin(x))
fig
Then run:
uvx marimo-md-export notebook.py output.md
This writes output.md, plus output_assets/notebook.html and output_assets/figure-1.png (and so on).
Integrating with documentation sites
marimo-md-export is designed to produce markdown pages for static site generators like mkdocs or zensical.
Both work identically for this purpose.
1. Add as a docs dependency:
uv add --group docs marimo-md-export
2. Add a build step that converts your notebook(s) before building the site.
For example, this project uses the following just command to build the docs:
docs:
marimo-md-export examples/notebook.py docs/example.md
zensical build
This runs marimo-md-export to produce a markdown page (with cell outputs injected) and its assets directory, then builds the site.
Developer setup
Install the project and its development dependencies with
uv sync
A justfile provides the common tasks.
just # runs everything
just -l # list commands
If you don't have just on your PATH, prefix with uv run.
Install pre-commit so that the hooks in .pre-commit-config.yaml run before each commit:
uv tool install pre-commit
pre-commit install
Contributing
Contributions are welcome. Feel free to use Issues to ask questions or propose ideas.
Pull Requests should be opened against main.
Please make sure the pre-commit hooks are passing and just runs without complaints.
1 maintainer
Metadata
1 maintainer
Release files for marimo-md-export 0.10.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| marimo_md_export-0.10.1.tar.gz | 18.6 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| marimo_md_export-0.10.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 41.4 kB
Release files / marimo_md_export-0.10.1.tar.gz
| Download URL | marimo_md_export-0.10.1.tar.gz |
|---|---|
| Size | 18.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
db7ae65a2cad84581fde2b573eaff799289e57dcab009b57a8ea0b0908a8cc2e
|
|
BLAKE2b-256 checksum How to use checksums |
64e94a27d2a7cf0833806d8691ab0031b2eebcf8d466a4d9d8440ef477662c19
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.12.17 {"installer":{"name":"uv","version":"0.12.17","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / marimo_md_export-0.10.1-py3-none-any.whl
| Download URL | marimo_md_export-0.10.1-py3-none-any.whl |
|---|---|
| Size | 22.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
dc2f9a352e34d3a13f2738a122e836f208b2aa50f9b9e83a94a61dd8070ff12b
|
|
BLAKE2b-256 checksum How to use checksums |
20b05bb6a9a85dbe36b3e625ec01e8a3b4b9b9b8c8858277065fba88f414f264
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.12.17 {"installer":{"name":"uv","version":"0.12.17","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Security for marimo-md-export 0.10.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
