Static site generator for the RESO Data Dictionary documentation. Produces a browsable, searchable reference for DD fields, resources, lookups and cross-references across all published versions.
- Multi-version documentation (DD 1.7, 2.0, 2.1)
- Resource and field detail pages with usage/adoption statistics
- Shared lookup pages organized by LookupName
- Browse By dimensions (Payload, Property Type, Element Status, Version Added)
- Sortable tables, inline search filters and grouped field views
- Dark/light theme toggle
- Full-text search via Pagefind
- Mobile-optimized layout with sticky headers
npm install
npm run fetch-data # Download XLSX reference sheets
npm run generate # Generate static HTMLThe generated site is written to dd-output/.
- Reference sheets: XLSX files fetched from the web-api-commander repo
- Usage statistics: Adoption data fetched from the RESO aggregation API (requires credentials)
The site is built and deployed automatically via GitHub Actions:
| Trigger | Purpose |
|---|---|
repository_dispatch |
Rebuild when reference sheets change in the commander repo |
| Weekly cron (Monday 6am UTC) | Refresh adoption/usage analytics |
workflow_dispatch |
Manual on-demand builds |
npm run lint # Check with Biome
npm run lint:fix # Auto-fixSee LICENSE.