LLMs

shadcnmaps provides machine-readable documentation files for AI assistants, coding agents, and LLM-powered tools. These follow the llms.txt convention.

Files

FileDescription
/llms.txtConcise index — project overview, AI tips, links to all maps and examples
/llms-full.txtFull documentation — getting started, API reference, theming, and map/example links

Per-page files

Detailed docs for individual maps and examples are available under /llms/:

FileDescription
/llms/france.mdFrance Map — installation, basic usage, props, types, CSS variables
/llms/usa.mdUSA Map — installation, basic usage, props, types, CSS variables
/llms/choropleth.mdChoropleth example — data-driven region coloring
/llms/markers.mdMarkers example — custom SVG marker overlays
/llms/region-click.mdRegion Click example — click-to-select interaction

How to use

Point your AI tool at the appropriate file:

  • Quick context — use /llms.txt for a concise overview
  • Full reference — use /llms-full.txt for complete documentation in one file
  • Specific topic — use /llms/<slug>.md for focused detail on a single map or example

Or simply use prompts such as:

shell
Install https://www.shadcnmaps.com/maps/world
sh
Create a page with https://www.shadcnmaps.com/maps/world including map controls