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.4.3.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.4.3-py3-none-any.whl (14.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: marimo_md_export-0.4.3.tar.gz
  • Upload date:
  • Size: 11.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.9 {"installer":{"name":"uv","version":"0.11.9","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.4.3.tar.gz
Algorithm Hash digest
SHA256 e5cb973d13352d9c1135435839a1b348f68e74b24fe6255bd26a7237f23bbc69
MD5 9b4b770ecfa073bfd8efebb3ef2549b0
BLAKE2b-256 1f0e64cc1a448e156d8cdba5ab4d6b98e690047f58bd59075d652414a8717048

See more details on using hashes here.

File details

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

File metadata

  • Download URL: marimo_md_export-0.4.3-py3-none-any.whl
  • Upload date:
  • Size: 14.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.9 {"installer":{"name":"uv","version":"0.11.9","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.4.3-py3-none-any.whl
Algorithm Hash digest
SHA256 2c4b963918c12687a95276e69eacf3e712880a3b71db670a7f6b8e5a074f5889
MD5 531f876bd64894d56f83354201f870dc
BLAKE2b-256 bc4312c73586e4d88841ab7ab0629c057ad0fd35e4f5b447dd4c9fd575e8dc13

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