Skip to main content

MkDocs marimo plugin

Project description

MkDocs marimo Plugin

[!WARNING] The MkDocs marimo plugin is under active development. Features and documentation are being continuously updated and expanded.

This plugin allows you to embed interactive marimo notebooks in your MkDocs documentation.

Installation

# pip
pip install mkdocs-marimo
# uv
uv pip install mkdocs-marimo
# pixi
pixi add mkdocs-marimo

Usage

Create reactive and interactive Python blocks in your markdown files using marimo.

```python {marimo}
import marimo as mo

name = mo.ui.text(placeholder="Enter your name")
name
```

```python {marimo}
mo.md(f"Hello, **{name.value or '__'}**!")
```

Checkout the documentation for more examples.

Contributions welcome

Feel free to ask questions, enhancements and to contribute to this project!

See CONTRIBUTING.md for more details.

Credits

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

mkdocs_marimo-0.1.1.tar.gz (12.0 kB view details)

Uploaded Source

Built Distribution

mkdocs_marimo-0.1.1-py3-none-any.whl (9.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mkdocs_marimo-0.1.1.tar.gz
  • Upload date:
  • Size: 12.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for mkdocs_marimo-0.1.1.tar.gz
Algorithm Hash digest
SHA256 043fef9dfac4ad1fa7cbc2c39f0a5e05a5c6e6f4d7bf7034bf5fc5e174095156
MD5 ddf0c9dab759c30113c6209bbaccbe80
BLAKE2b-256 8affd5fe226109c6e1520d3e463a1ae61832834596f6c07903dcba67bfb7a2f7

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mkdocs_marimo-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 40f10fe881c7a88b4d1b54eb3aabdba2e98673484ba85fcf083da42d39868a6b
MD5 d42f430c909985fe6269908071ee70fb
BLAKE2b-256 77ad35558bda27c25af0a91b1fe8efa29fea1569d52cdf8ad132083c638e70da

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page