Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# mkdocs-marimo

MkDocs plugin that renders reactive marimo cells in Markdown docs. Published to PyPI as `mkdocs-marimo`.

## Development

Tooling is driven by [pixi](https://pixi.sh) (all tasks defined in `pixi.toml`):

```bash
pixi run postinstall # editable install into the env
pixi run test # pytest
pixi run mypy mkdocs_marimo # type check
pixi run pre-commit-run # lint/format (ruff, taplo, typos) — matches CI lint job
pixi run docs # serve docs locally (pixi run docs-build to build)
```

- CI runs `test` + `mypy` across the `py39`–`py313` environments (`pixi run -e py312 test`).
- No pixi? These map to `pytest`, `mypy`, and `pre-commit run -a` under the env deps in `pixi.toml`.
1 change: 1 addition & 0 deletions CLAUDE.md