Repository files navigation

This site is built with TanStack Router!

• TanStack Router Docs

It's deployed automagically with Netlify!

• Netlify

From your terminal:

pnpm installpnpm dev

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

The documentations for all TanStack projects except forReact Charts are hosted onhttps://tanstack.com, powered by this TanStack Router app.In production, the markdown doc pages are fetched from the GitHub repos of the projects, but in development they are read from the local file system.

Follow these steps if you want to edit the doc pages of a project (in these steps we'll assume it'sTanStack/form) and preview them locally :

1. Create a new directory calledtanstack.

mkdir tanstack

2. Enter the directory and clone this repo and the repo of the project there.

cd tanstackgit clone git@github.com:TanStack/tanstack.com.gitgit clone git@github.com:TanStack/form.git

tanstack/   |   +-- form/   |   +-- tanstack.com/

3. Enter thetanstack/tanstack.com directory, install the dependencies and run the app in dev mode:

cd tanstack.compnpm i# The app will run on https://localhost:3000 by defaultpnpm dev

4. Now you can visithttp://localhost:3000/form/latest/docs/overview in the browser and see the changes you make intanstack/form/docs.