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

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) and tables (as GFM or HTML).

Full documentation

Quick start

Mark cells in your marimo .py notebook with # @output: <label>:

# @output: my_figure
fig, ax = plt.subplots()
ax.plot(x, np.sin(x))
fig

Then run:

uvx marimo-md-export notebook.py output.md

Installation

uv tool install marimo-md-export   # or: pipx install marimo-md-export

Development

uv sync
just test
just 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.1.1.tar.gz (7.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.1.1-py3-none-any.whl (10.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: marimo_md_export-0.1.1.tar.gz
  • Upload date:
  • Size: 7.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.8 {"installer":{"name":"uv","version":"0.11.8","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.1.1.tar.gz
Algorithm Hash digest
SHA256 1b213ac2ec88ce52cfc0760671ce157075e03a6082f051d86d33172274c2c359
MD5 863bf6bdf1b6c959fd0e790af708b52b
BLAKE2b-256 e835e56b61a6a3085e0f47712871dc5a3d93894747e11ac10e8eb12f3b5babf6

See more details on using hashes here.

File details

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

File metadata

  • Download URL: marimo_md_export-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 10.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.8 {"installer":{"name":"uv","version":"0.11.8","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.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b233473868575dc418c31da07d267c57cfd988af60e9d89543eaa8451de27799
MD5 1763b782d6bbe9a2fb5393174fa2462a
BLAKE2b-256 fabc380ac2203d3343f9256457dcbcf225344c0bb5d2a3cc840c539491185a7c

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