Skip to main content

marimo-md-export

PyPI version Python versions License CI Docs

A uv tool that wraps marimo export, extracts rendered outputs from the HTML export, and injects them into the markdown export. The result is a self-contained markdown document with embedded figures (as base64 <img> tags), tables (as GFM or HTML), and other cell outputs. Pass --figures-dir to write figures out as image files and link to them with ![alt](path) instead of embedding them.

Full documentation

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

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 self-contained markdown page (with cell outputs injected), then builds the site.

Development

uv sync  # sync packages
just  # run lint, typecheck, test, build docs

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

marimo_md_export-0.9.0.tar.gz (15.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

marimo_md_export-0.9.0-py3-none-any.whl (19.1 kB view details)

Uploaded Python 3

File details

Details for the file marimo_md_export-0.9.0.tar.gz.

File metadata

  • Download URL: marimo_md_export-0.9.0.tar.gz
  • Upload date:
  • Size: 15.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.12.3 {"installer":{"name":"uv","version":"0.12.3","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}

File hashes

Hashes for marimo_md_export-0.9.0.tar.gz
Algorithm Hash digest
SHA256 3435091b707ab58b8af0b41b79c61b1e4e55c27c4b05c14e9c85a9780b343508
MD5 988dae9e6a71be453f9b7239b2a631f2
BLAKE2b-256 fe1e7a0916cc18dbe345783fc3b6f1e3ffe78e32c46dd037a419e630dc15be2c

See more details on using hashes here.

File details

Details for the file marimo_md_export-0.9.0-py3-none-any.whl.

File metadata

  • Download URL: marimo_md_export-0.9.0-py3-none-any.whl
  • Upload date:
  • Size: 19.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.12.3 {"installer":{"name":"uv","version":"0.12.3","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}

File hashes

Hashes for marimo_md_export-0.9.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3e9a87c6814c65c10e041b53543e44d1f2650d263e9b2a235f43b3f40fb0e67f
MD5 bb581a3a271b899c9e17a3456551ca56
BLAKE2b-256 329a2416a50b64f27ff163752340449af09d3e92e038de3f0cfee1fa78fa052b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page