exdoc-config
Installation
SKILL.md
ExDoc Configuration
Quick Reference
| Topic | Reference |
|---|---|
| Markdown, cheatsheets (.cheatmd), livebooks (.livemd) | references/extras-formats.md |
| Custom head/body tags, syntax highlighting, nesting, annotations | references/advanced-config.md |
Gates
Use this sequence before claiming ExDoc is wired correctly or that docs build:
- Dependencies resolved — Run
mix deps.getfrom the project root. Pass: exit code0, andmix.exsincludesex_docas in Dependency Setup (or the project’s equivalent dev-only docs dep). - Extra paths real — For every path string in
extras/0(and ingroups_for_extras/0if used), confirm that path exists in the repo or you have just created that file. Pass: no stale or typo paths remain when you runmix docs. - Docs build — Run
mix docs. Pass: exit code0, and the HTML entry exists at<output>/index.html(default<project>/doc/index.html; usedocs: [output: ...]if you changedoutput).
For cheatsheets, livebooks, or custom head/body assets, follow the same “path exists before listing” rule; see When to Load References.