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.0.tar.gz (6.9 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.0-py3-none-any.whl (10.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: marimo_md_export-0.1.0.tar.gz
  • Upload date:
  • Size: 6.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for marimo_md_export-0.1.0.tar.gz
Algorithm Hash digest
SHA256 d6d92d81244249d91be7015c1593e5002c387dbd28fa0d0e9cba63ac592f7ad6
MD5 7f8d1347c2e56b8f36cac1747ddd3c4a
BLAKE2b-256 04039290cde07a46623e41e7efde53cb8a15d8b5ac545a8064c259f52fe6c3a0

See more details on using hashes here.

Provenance

The following attestation bundles were made for marimo_md_export-0.1.0.tar.gz:

Publisher: publish.yml on jmarshrossney/marimo-md-export

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

File hashes

Hashes for marimo_md_export-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a9c9a4cb1a2136a1ece56c0d1fb62e09b3446b84c7a6c9a1583325342c9f1a07
MD5 763b1a6e6dfda9658b66987dcc3c876a
BLAKE2b-256 2ee76aa94acfe047f95a7564ac1241074c4651c25708ab95e0b19a3cb75baa35

See more details on using hashes here.

Provenance

The following attestation bundles were made for marimo_md_export-0.1.0-py3-none-any.whl:

Publisher: publish.yml on jmarshrossney/marimo-md-export

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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