Skip to main content

A minimal solution for exporting marimo notebooks to markdown *with* rendered HTML outputs, designed for mkdocs/zensical sites.

Project description

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

Project details


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.5.2.tar.gz (11.6 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.5.2-py3-none-any.whl (14.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: marimo_md_export-0.5.2.tar.gz
  • Upload date:
  • Size: 11.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.10 {"installer":{"name":"uv","version":"0.11.10","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.5.2.tar.gz
Algorithm Hash digest
SHA256 8d83cf206bbccf80b8a030ec9ed3856207fd988a5ca65743d27bd96d89bdf7c4
MD5 fee3e75fa8773b8e70a17519fd695071
BLAKE2b-256 2e81d481c7a09526251faa1967d72aa58a4d0d75bd7c2102698991332a9696b1

See more details on using hashes here.

File details

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

File metadata

  • Download URL: marimo_md_export-0.5.2-py3-none-any.whl
  • Upload date:
  • Size: 14.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.10 {"installer":{"name":"uv","version":"0.11.10","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.5.2-py3-none-any.whl
Algorithm Hash digest
SHA256 0e679f3737aa71d887e08b8696da7af420506faee577a9fcdba70151952eb014
MD5 895617e58baf5ad4c968d9d783cddcd3
BLAKE2b-256 684d5ca453cee9dd140176302a860a929912e63f3a2598dff4adeedcc002af17

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 Pingdom Monitoring Sentry Error logging StatusPage Status page