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  # 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.2.0.tar.gz (8.3 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.2.0-py3-none-any.whl (11.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: marimo_md_export-0.2.0.tar.gz
  • Upload date:
  • Size: 8.3 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.2.0.tar.gz
Algorithm Hash digest
SHA256 4579395779305be0ff87aceaa121d2b96bdfc79f532bc8c28259fff370e6b2da
MD5 746012a1b3a4ab3f8266bcebb8006d43
BLAKE2b-256 49b786d5f63c511b80d66729d4cc5af4bbdf6cc1a7e59baa884349d7c96714a3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: marimo_md_export-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 11.5 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.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 503d2fa329aae8338af9a13d4347410a75c116acde46e3a0fcb46aeea33d03e9
MD5 3faa8c17852e443f9147f56d3b9bfd93
BLAKE2b-256 6212c61d646c56a833cb7b517af0b5057a29296fbc055bcc6abba64bdbb1b899

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