LLMs
shadcnmaps provides machine-readable documentation files for AI assistants, coding agents, and LLM-powered tools. These follow the llms.txt convention.
Files
| File | Description |
|---|---|
/llms.txt | Concise index — project overview, AI tips, links to all maps and examples |
/llms-full.txt | Full documentation — getting started, API reference, theming, and map/example links |
Per-page files
Detailed docs for individual maps and examples are available under /llms/:
| File | Description |
|---|---|
/llms/usa-map.md | USA Map — installation, basic usage, props, types, CSS variables |
/llms/choropleth.md | Choropleth example — data-driven region coloring |
/llms/markers.md | Markers example — custom SVG marker overlays |
/llms/region-click.md | Region Click example — click-to-select interaction |
How to use
Point your AI tool at the appropriate file:
- Quick context — use
/llms.txtfor a concise overview - Full reference — use
/llms-full.txtfor complete documentation in one file - Specific topic — use
/llms/<slug>.mdfor focused detail on a single map or example
Auto-generation
These files are auto-generated from the MDX source pages by scripts/build-llms.ts. They are rebuilt as part of pnpm registry:build and via lint-staged when MDX files are committed.