{"id":17605942,"url":"https://github.com/marimo-team/mkdocs-marimo","last_synced_at":"2025-04-30T10:47:38.629Z","repository":{"id":259050534,"uuid":"858888709","full_name":"marimo-team/mkdocs-marimo","owner":"marimo-team","description":"mkdocs plugin for reactive and interactive docs with marimo","archived":false,"fork":false,"pushed_at":"2025-03-03T00:43:06.000Z","size":1517,"stargazers_count":27,"open_issues_count":5,"forks_count":1,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-03-06T09:23:20.203Z","etag":null,"topics":["marimo","mkdocs","mkdocs-plugin"],"latest_commit_sha":null,"homepage":"https://marimo-team.github.io/mkdocs-marimo/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/marimo-team.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-09-17T17:51:58.000Z","updated_at":"2025-03-03T00:42:39.000Z","dependencies_parsed_at":"2025-01-01T06:17:36.837Z","dependency_job_id":"a084fec5-e22b-4314-a745-75c411adad78","html_url":"https://github.com/marimo-team/mkdocs-marimo","commit_stats":null,"previous_names":["marimo-team/mkdocs-marimo"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marimo-team%2Fmkdocs-marimo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marimo-team%2Fmkdocs-marimo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marimo-team%2Fmkdocs-marimo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marimo-team%2Fmkdocs-marimo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/marimo-team","download_url":"https://codeload.github.com/marimo-team/mkdocs-marimo/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242182553,"owners_count":20085530,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["marimo","mkdocs","mkdocs-plugin"],"created_at":"2024-10-22T15:12:23.663Z","updated_at":"2025-03-09T03:31:48.574Z","avatar_url":"https://github.com/marimo-team.png","language":"Python","funding_links":[],"categories":["Python","Libraries"],"sub_categories":["Deployment Templates"],"readme":"# MkDocs marimo Plugin\n\n\u003e [!WARNING]\n\u003e The MkDocs marimo plugin is under active development. Features and documentation are being continuously updated and expanded.\n\nThis plugin allows you to embed interactive [marimo](https://github.com/marimo-team/marimo) notebooks in your MkDocs documentation.\n\n## Installation\n\n```bash\n# pip\npip install mkdocs-marimo\n# uv\nuv pip install mkdocs-marimo\n# pixi\npixi add mkdocs-marimo\n```\n\n## Usage\n\nCreate reactive and interactive Python blocks in your markdown files using [marimo](https://github.com/marimo-team/marimo).\n\n### Embedding inline Python code and marimo elements\n\nThis uses code fences to embed marimo components as [marimo islands](https://docs.marimo.io/guides/exporting/?h=#embed-marimo-outputs-in-html-using-islands).\n\n````markdown\n```python {marimo}\nimport marimo as mo\n\nname = mo.ui.text(placeholder=\"Enter your name\")\nname\n```\n\n```python {marimo}\nmo.md(f\"Hello, **{name.value or '__'}**!\")\n```\n````\n\n### Embedding the marimo playground\n\nFor an easy way to embed marimo notebooks or applications, we recommend embedding the marimo playground. This feature uses `pymdownx.blocks` to embed marimo notebooks in your MkDocs documentation, creating iframes that render the marimo playground.\n\n````markdown\n/// marimo-embed\n    height: 400px\n    mode: run\n\n```python\n@app.cell\ndef __():\n    import matplotlib.pyplot as plt\n    import numpy as np\n\n    x = np.linspace(0, 10, 100)\n    y = np.sin(x)\n\n    plt.figure(figsize=(8, 4))\n    plt.plot(x, y)\n    plt.title('Sine Wave')\n    plt.xlabel('x')\n    plt.ylabel('sin(x)')\n    plt.grid(True)\n    plt.gca()\n    return\n```\n///\n````\n\nAvailable options for `marimo-embed`:\n\n- `height`: Named sizes (`small`, `medium`, `large`, `xlarge`, `xxlarge`) or custom pixel values (e.g. `500px`) (default: medium)\n- `mode`: read, edit (default: read)\n- `app_width`: wide, full, compact (default: wide)\n\nYou can also embed marimo files directly:\n\n````markdown\n/// marimo-embed-file\n    filepath: path/to/your/file.py\n    height: 400px\n    mode: read\n    show_source: true\n///\n````\n\nAdditional options for `marimo-embed-file`:\n\n- `filepath`: path to the marimo file to embed (required)\n- `show_source`: true, false (default: true) - whether to show the source code below the embed\n\n## Examples\n\nCheckout the [documentation](https://marimo-team.github.io/mkdocs-marimo) for more examples.\n\n## Contributions welcome\n\nFeel free to ask questions, enhancements and to contribute to this project!\n\nSee [CONTRIBUTING.md](CONTRIBUTING.md) for more details.\n\n## Credits\n\n- Repo template from [mkdocs-static-i18n](https://github.com/ultrabug/mkdocs-static-i18n)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarimo-team%2Fmkdocs-marimo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmarimo-team%2Fmkdocs-marimo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarimo-team%2Fmkdocs-marimo/lists"}