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.

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.8.0.tar.gz (13.1 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.8.0-py3-none-any.whl (16.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: marimo_md_export-0.8.0.tar.gz
  • Upload date:
  • Size: 13.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.31 {"installer":{"name":"uv","version":"0.11.31","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.8.0.tar.gz
Algorithm Hash digest
SHA256 69cbb333cf595eea58bea401025b85c99a063b82242e1b3a4c01ce0642b300b7
MD5 c35549839b9baa94a9efcab89b5033dd
BLAKE2b-256 42e8168ea03f9a744973473789cf0c6f3bc7f677c00767f35e8f6b897bce07e3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: marimo_md_export-0.8.0-py3-none-any.whl
  • Upload date:
  • Size: 16.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.31 {"installer":{"name":"uv","version":"0.11.31","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.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5b77c5ddea514c6d97cd520a66a1a865d9ba30265adfa7511d2cad5698d9702b
MD5 2cf4bd406838b3b9deea4d0829622a05
BLAKE2b-256 fabef2f0f441504b2c766a68925c06a02212ce1d91b82368077170f31478f721

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