MakerFLOSS/scripts/README.md

8 lines
610 B
Markdown
Raw Permalink Normal View History

# scripts/
Build helpers for the documentation site.
- `gen_overview.py` — generates a category index table from per-item YAML frontmatter (currently used for `docs/hardware/index.md`). Configured by `overview_config.yml`. Run via `make docs-index`; CI drift-checks it via `make docs-check`.
- `mkdocs_hooks.py` — MkDocs build hook that renders a Specs table on each hardware host page from its frontmatter, sharing `fmt_*` helpers with `gen_overview.py` so the host page and the index row stay in sync.
- `overview_config.yml` — schema (required fields, enums) and table layout for `gen_overview.py`.