https://github.com/marimo-team/mkdocs-marimo

mkdocs plugin for reactive and interactive docs with marimo
https://github.com/marimo-team/mkdocs-marimo

marimo mkdocs mkdocs-plugin

Last synced: 21 days ago
JSON representation

mkdocs plugin for reactive and interactive docs with marimo

• Host: GitHub
• URL: https://github.com/marimo-team/mkdocs-marimo
• Owner: marimo-team
• License: apache-2.0
• Created: 2024-09-17T17:51:58.000Z (about 2 months ago)
• Default Branch: main
• Last Pushed: 2024-10-21T23:27:39.000Z (22 days ago)
• Last Synced: 2024-10-22T01:22:45.133Z (22 days ago)
• Topics: marimo, mkdocs, mkdocs-plugin
• Language: Python
• Homepage: https://marimo-team.github.io/mkdocs-marimo/
• Size: 912 KB
• Stars: 3
• Watchers: 4
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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](https://github.com/marimo-team/marimo) notebooks in your MkDocs documentation.

## Installation

```bash

# 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](https://github.com/marimo-team/marimo).

````markdown

```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](https://marimo-team.github.io/mkdocs-marimo) for more examples.

## Contributions welcome

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

See [CONTRIBUTING.md](CONTRIBUTING.md) for more details.

## Credits

- Repo template from [mkdocs-static-i18n](https://github.com/ultrabug/mkdocs-static-i18n)