diff --git a/AGENTS.md b/AGENTS.md index cd3724c8..6dcaf4df 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -154,6 +154,16 @@ Documentation files to check: - `docs/LLM_HANDOVER.md` - All pages under `docs/` +### Docs Site (Zensical) + +The documentation site is built with **[Zensical](https://zensical.org)**, configured via `zensical.toml`. Key rules when editing docs pages: + +- **Snippets for shared content.** Reusable blocks live in `docs/_snippets/` and are included with `--8<-- "docs/_snippets/.md"`. If you find the same content repeated across pages, extract it into a snippet rather than duplicating it. +- **Icon shortcodes require the `pymdownx.emoji` extension** with `emoji_index` and `emoji_generator` set to the `zensical.extensions.emoji` namespace (not the default `pymdownx` one). Without this, `:material-*:` and `:octicons-*:` shortcodes render as raw text. +- **Grid cards** (`
`) require both `attr_list` and `md_in_html` extensions in `zensical.toml`. +- **Videos from GitHub** use `