Skip to content

Latest commit

 

History

2,286 提交

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

仓库 files navigation

TanStack.com

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

关注 @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

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

探索 the TanStack Ecosystem

… and more at TanStack.com »

关于

The marketing and docs site for all TanStack projects

Resources

Stars

1.1k stars

关注者

11 watching

复刻s

Sponsor this project

Used by

贡献者

Languages