Skip to content

Latest commit

 

History

2,365 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

TanStack.com

The home of the TanStack ecosystem. Built with TanStack Router and deployed on Cloudflare Workers.

Follow @TanStack

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.

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

Explore the TanStack Ecosystem

… and more at TanStack.com »

TanChat alpha access

TanChat is invite-only, independent of Builder access. Signing in to TanStack does not unlock it. Admins and TanStack maintainers with a linked GitHub account have automatic access and unlimited invites. Maintainer identity comes from the verified GitHub account ID and the site's maintainer catalog, not an editable profile name.

Other users unlock TanChat by redeeming a single-use invite and receive three invites to share. Issuing a link consumes one invite, even if the link expires unused. Links expire after seven days. Account settings links to /chat-access, where users can create and copy invites. The main site menu links to TanChat, and accounts without access see the invite page.

Migration 0039_tanchat_invites adds grants and hashed invite tokens. Server functions and chat HTTP endpoints enforce access independently of the UI. Quota checks lock the issuer account, and redemption locks the invite while granting access and consuming it in one transaction. The local app uses the shared configured database, so invite grants also persist for future production releases.

About

The marketing and docs site for all TanStack projects

Resources

Stars

1.1k stars

Watchers

11 watching

Forks

Sponsor this project

Used by

Contributors

Languages