You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The home of the TanStack ecosystem. Built with [TanStack Router](https://tanstack.com/router) and deployed automagically with [Netlify](https://netlify.com/).
### [Become a Sponsor!](https://github.com/sponsors/tannerlinsley/)
10
+
11
+
</div>
10
12
11
13
## Development
12
14
@@ -19,54 +21,66 @@ pnpm dev
19
21
20
22
This starts your app in development mode, rebuilding assets on file changes.
21
23
22
-
## Editing and previewing the docs of TanStack projects locally
24
+
## Local Setup for Docs & Commits
23
25
24
-
The documentations for all TanStack projects except for `React Charts` are hosted on [https://tanstack.com](https://tanstack.com), powered by this TanStack Router app.
25
-
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.
26
+
The documentation for all TanStack projects (except `React Charts`) is hosted on [tanstack.com](https://tanstack.com). In production, doc pages are fetched from GitHub. In development, they're read from your local file system.
26
27
27
-
Follow these steps if you want to edit the doc pages of a project (in these steps we'll assume it's [`TanStack/form`](https://github.com/tanstack/form)) and preview them locally :
28
+
Pre-commit hooks run smoke tests against these docs, so you'll need sibling repos cloned for commits to pass.
28
29
29
-
1.Create a new directory called `tanstack`.
30
+
Create a `tanstack` parent directory and clone this repo alongside the projects:
> Directory names must match repo names exactly (e.g., `query` not `tanstack-query`). The app finds docs by looking for sibling directories by name.
52
+
53
+
## Editing Docs
54
+
55
+
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.
42
56
43
57
> [!NOTE]
44
-
> Your `tanstack` directory should look like this:
45
-
>
46
-
> ```
47
-
> tanstack/
48
-
> |
49
-
> +-- form/
50
-
> |
51
-
> +-- tanstack.com/
52
-
> ```
58
+
> Updated pages need to be manually reloaded in the browser.
53
59
54
60
> [!WARNING]
55
-
> Make sure the name of the directory in your local file system matches the name of the project's repo. For example, `tanstack/form` must be cloned into `form` (this is the default) instead of `some-other-name`, because that way, the doc pages won't be found.
61
+
> Update the project's `docs/config.json` if you add a new doc page!
56
62
57
-
3. Enter the `tanstack/tanstack.com` directory, install the dependencies and run the app in dev mode:
63
+
## Get Involved
58
64
59
-
```sh
60
-
cd tanstack.com
61
-
pnpm i
62
-
# The app will run on https://localhost:3000 by default
63
-
pnpm dev
64
-
```
65
+
- We welcome issues and pull requests!
66
+
- Participate in [GitHub Discussions](https://github.com/TanStack/tanstack.com/discussions)
67
+
- Chat with the community on [Discord](https://discord.com/invite/WrRKjPJ)
65
68
66
-
4. Now you can visit http://localhost:3000/form/latest/docs/overview in the browser and see the changes you make in `tanstack/form/docs`.
69
+
## Explore the TanStack Ecosystem
67
70
68
-
> [!NOTE]
69
-
> The updated pages need to be manually reloaded in the browser.
71
+
- <ahref="https://github.com/tanstack/config"><b>TanStack Config</b></a> – Tooling for JS/TS packages
72
+
- <ahref="https://github.com/tanstack/db"><b>TanStack DB</b></a> – Reactive sync client store
0 commit comments