# Instant Map

> Instant Map is an open-source map for the web. The first view is a single server-rendered image that needs no JavaScript; a small custom element, <instant-map>, loads after it (about 7 KB gzipped) and fetches the interactive engine (about 11 KB gzipped) the first time someone touches the map. It works in any framework because it is a standard web component, with a React adapter and a server helper for building image URLs.

To add Instant Map to a project: install the `instantmap-js` package (or load https://instantmap.org/instant-map.js as a module script), render an <instant-map> element with center and zoom, give it an explicit height, and pass markers as an array of { id, lng, lat, label, title, subtitle, image, badge, href }. To match a brand, build the colours with brandTheme({ primary, background, foreground }) and pass the result as theme and colors. In server-rendered frameworks render the poster <img> on the server with staticUrl() from `instantmap-js/server` so the map paints before any JavaScript runs. Every docs page is also available as Markdown by adding .md to its URL.

## Documentation Sets

- [Abridged documentation](https://instantmap.org/llms-small.txt): a compact version of the documentation for Instant Map, with non-essential content removed
- [Complete documentation](https://instantmap.org/llms-full.txt): the full documentation for Instant Map
- [Frameworks](https://instantmap.org/_llms-txt/frameworks.txt): Step-by-step integration for each framework
- [Reference](https://instantmap.org/_llms-txt/reference.txt): Complete API reference

## Notes

- The complete documentation includes all content from the official documentation
- The content is automatically generated from the same source as the official documentation