Development

Quick Start

From your terminal:

pnpm install
pnpm dev

This starts your app in development mode, rebuilding assets on file changes.

Local Setup

The documentation for all TanStack projects (except React Charts) is hosted on tanstack.com. In production, doc pages are fetched from GitHub. In development, they’re read from your local file system.

Pre-commit hooks run smoke tests against these docs, so you’ll need sibling repos cloned for commits to pass.

Create a tanstack parent directory and clone this repo alongside the projects:

mkdir tanstack && cd tanstack
git clone git@github.com:TanStack/tanstack.com.git
git clone git@github.com:TanStack/query.git
git clone git@github.com:TanStack/router.git
git clone git@github.com:TanStack/table.git

Your directory structure should look like this:

tanstack/
   ├── tanstack.com/
   ├── query/
   ├── router/
   └── table/

[!WARNING]
Directory names must match repo names exactly (e.g., query not tanstack-query). The app finds docs by looking for sibling directories by name.

Editing Docs

To edit docs for a project, make changes in its docs/ folder (e.g., ../form/docs/) and visit http://localhost:3000/form/latest/docs/overview to preview.

[!NOTE]
Updated pages need to be manually reloaded in the browser.

[!WARNING]
Update the project’s docs/config.json if you add a new doc page!

Get Involved

• We welcome issues and pull requests!
• Participate in GitHub Discussions
• Chat with the community on Discord

Explore the TanStack Ecosystem

• TanStack Config – Tooling for JS/TS packages
• TanStack DB – Reactive sync client store
• TanStack DevTools – Unified devtools panel
• TanStack Form – Type‑safe form state
• TanStack Pacer – Debouncing, throttling, batching
• TanStack Query – Async state & caching
• TanStack Ranger – Range & slider primitives
• TanStack Router – Type‑safe routing, caching & URL state
• TanStack Start – Full‑stack SSR & streaming
• TanStack Store – Reactive data store
• TanStack Table – Headless datagrids
• TanStack Virtual – Virtualized rendering

… and more at TanStack.com »