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
- Repo template from mkdocs-static-i18n
Project details
Release history Release notifications | RSS feed
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.2.tar.gz
(12.1 kB
view details)
Built Distribution
File details
Details for the file mkdocs_marimo-0.1.2.tar.gz
.
File metadata
- Download URL: mkdocs_marimo-0.1.2.tar.gz
- Upload date:
- Size: 12.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.1 CPython/3.12.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9ac2fb08850f2f0f5ab01d06673b18425e678be660d5493ab7e7810993e60fce |
|
MD5 | 8c22948a87fcd551cd90e27ddd3cdba0 |
|
BLAKE2b-256 | 5e7df6e99cbe70674df64647de7307947b92fbb28ac4378e863200b7933d8f52 |
File details
Details for the file mkdocs_marimo-0.1.2-py3-none-any.whl
.
File metadata
- Download URL: mkdocs_marimo-0.1.2-py3-none-any.whl
- Upload date:
- Size: 9.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.1 CPython/3.12.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | a369c6c881b250631da903d93e70a592e9596b387cb26c74448ea089ed76373e |
|
MD5 | a542a3e894c32f78e346bfd3325a8756 |
|
BLAKE2b-256 | 07aacd9623460d6bdc2fa6ebcdabd718d17fef74ef1d24f73b762cfaedf72d2b |