# tourkit docs

Documentation for tourkit, a product tour and onboarding walkthrough library for React and
React Native. Every page below is also available as markdown by appending `.md` to its URL, or
by sending `Accept: text/markdown`.

## Start

- [Getting started](https://www.tourkit.tech/docs/getting-started.md): Install, then a working tour in four steps on either platform.
- [Adding it to an app](https://www.tourkit.tech/docs/integration.md): Where each file goes in Next.js, Vite and Expo Router, and where the client boundary falls.
- [Step reference](https://www.tourkit.tech/docs/steps.md): Every TourConfig and TourStep field, gates, and conditional steps.
- [Provider reference](https://www.tourkit.tech/docs/provider.md): Mounting TourProvider, its props per platform, events, and useTour().

## Guides

- [Customization](https://www.tourkit.tech/docs/customization.md): Theme tokens, component slots, and fully headless rendering.
- [Navigation](https://www.tourkit.tech/docs/navigation.md): Steps that cross routes, and createNavAdapter for Next, React Router and Expo.
- [Interaction](https://www.tourkit.tech/docs/interaction.md): block, passthrough and advance-on-press, and when to reach for each.
- [React Native](https://www.tourkit.tech/docs/react-native.md): Peer dependencies, TourTarget traps, safe areas, and how measurement works.
- [Hints](https://www.tourkit.tech/docs/hints.md): Standalone dots with popovers, independent of any running tour.
- [Accessibility](https://www.tourkit.tech/docs/accessibility.md): The keyboard map, the focus trap, screen readers, and what a custom card takes on.
- [Recipes](https://www.tourkit.tech/docs/recipes.md): Eleven task-shaped snippets for the situations that actually come up.

## Power tools

- [Recording a tour](https://www.tourkit.tech/docs/recorder.md): Click through your app and get a committable tour file.
- [CLI reference](https://www.tourkit.tech/docs/cli.md): tourkit init and tourkit record, flag by flag, and what init writes and wires.
- [Self-healing targets](https://www.tourkit.tech/docs/self-healing.md): Fingerprints, the scoring rules, and why it refuses to guess.
- [Ask and be shown](https://www.tourkit.tech/docs/ai.md): A user question becomes a tour of the real interface, with no tourkit service.

## Reference

- [API reference](https://www.tourkit.tech/docs/api.md): Every export from core, react, native, ai and ai/server, with signatures.
- [Theme reference](https://www.tourkit.tech/docs/theme.md): Every token, its type, its default, and the four that differ per platform.
- [Testing](https://www.tourkit.tech/docs/testing.md): Testing the config with no renderer, the tour in a DOM, and layout in a browser.
- [Troubleshooting](https://www.tourkit.tech/docs/troubleshooting.md): Symptoms, what causes them, and what to change.
- [Migrating](https://www.tourkit.tech/docs/migrating.md): Mapping tables from driver.js, react-joyride, copilot and rn-tourguide.

## Other machine-readable entry points

- [llms.txt](https://www.tourkit.tech/llms.txt): what tourkit is, when to use it, and a map of these pages.
- [Sitemap](https://www.tourkit.tech/sitemap.xml)