wcz-test 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +72 -0
- package/package.json +50 -0
package/README.md
ADDED
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
# Welcome to TanStack.com!
|
|
2
|
+
|
|
3
|
+
This site is built with TanStack Router!
|
|
4
|
+
|
|
5
|
+
- [TanStack Router Docs](https://tanstack.com/router)
|
|
6
|
+
|
|
7
|
+
It's deployed automagically with Netlify!
|
|
8
|
+
|
|
9
|
+
- [Netlify](https://netlify.com/)
|
|
10
|
+
|
|
11
|
+
## Development
|
|
12
|
+
|
|
13
|
+
From your terminal:
|
|
14
|
+
|
|
15
|
+
```sh
|
|
16
|
+
pnpm install
|
|
17
|
+
pnpm dev
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
This starts your app in development mode, rebuilding assets on file changes.
|
|
21
|
+
|
|
22
|
+
## Editing and previewing the docs of TanStack projects locally
|
|
23
|
+
|
|
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
|
+
|
|
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
|
+
|
|
29
|
+
1. Create a new directory called `tanstack`.
|
|
30
|
+
|
|
31
|
+
```sh
|
|
32
|
+
mkdir tanstack
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
2. Enter the directory and clone this repo and the repo of the project there.
|
|
36
|
+
|
|
37
|
+
```sh
|
|
38
|
+
cd tanstack
|
|
39
|
+
git clone git@github.com:TanStack/tanstack.com.git
|
|
40
|
+
git clone git@github.com:TanStack/form.git
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
> [!NOTE]
|
|
44
|
+
> Your `tanstack` directory should look like this:
|
|
45
|
+
>
|
|
46
|
+
> ```
|
|
47
|
+
> tanstack/
|
|
48
|
+
> |
|
|
49
|
+
> +-- form/
|
|
50
|
+
> |
|
|
51
|
+
> +-- tanstack.com/
|
|
52
|
+
> ```
|
|
53
|
+
|
|
54
|
+
> [!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.
|
|
56
|
+
|
|
57
|
+
3. Enter the `tanstack/tanstack.com` directory, install the dependencies and run the app in dev mode:
|
|
58
|
+
|
|
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
|
+
|
|
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`.
|
|
67
|
+
|
|
68
|
+
> [!NOTE]
|
|
69
|
+
> The updated pages need to be manually reloaded in the browser.
|
|
70
|
+
|
|
71
|
+
> [!WARNING]
|
|
72
|
+
> You will need to update the `docs/config.json` file (in the project's repo) if you add a new doc page!
|
package/package.json
ADDED
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "wcz-test",
|
|
3
|
+
"version": "1.0.0",
|
|
4
|
+
"private": false,
|
|
5
|
+
"sideEffects": false,
|
|
6
|
+
"type": "module",
|
|
7
|
+
"main": "dist/index.js",
|
|
8
|
+
"module": "dist/index.mjs",
|
|
9
|
+
"types": "dist/index.d.ts",
|
|
10
|
+
"files": [
|
|
11
|
+
"dist/"
|
|
12
|
+
],
|
|
13
|
+
"publishConfig": {
|
|
14
|
+
"access": "public"
|
|
15
|
+
},
|
|
16
|
+
"description": "A test package for demonstrating npm publishing best practices.",
|
|
17
|
+
"keywords": [
|
|
18
|
+
"react",
|
|
19
|
+
"router",
|
|
20
|
+
"tailwindcss"
|
|
21
|
+
],
|
|
22
|
+
"author": "Your Name <your.email@example.com>",
|
|
23
|
+
"license": "MIT",
|
|
24
|
+
"scripts": {
|
|
25
|
+
"dev": "vinxi dev",
|
|
26
|
+
"build": "vinxi build",
|
|
27
|
+
"start": "vinxi start",
|
|
28
|
+
"prepare": "vinxi build"
|
|
29
|
+
},
|
|
30
|
+
"dependencies": {
|
|
31
|
+
"@tanstack/react-router": "^1.115.2",
|
|
32
|
+
"@tanstack/react-router-devtools": "^1.115.2",
|
|
33
|
+
"@tanstack/react-start": "^1.115.2",
|
|
34
|
+
"react": "^19.0.0",
|
|
35
|
+
"react-dom": "^19.0.0",
|
|
36
|
+
"redaxios": "^0.5.1",
|
|
37
|
+
"tailwind-merge": "^2.6.0",
|
|
38
|
+
"vinxi": "0.5.3"
|
|
39
|
+
},
|
|
40
|
+
"devDependencies": {
|
|
41
|
+
"@types/node": "^22.5.4",
|
|
42
|
+
"@types/react": "^19.0.8",
|
|
43
|
+
"@types/react-dom": "^19.0.3",
|
|
44
|
+
"postcss": "^8.5.1",
|
|
45
|
+
"autoprefixer": "^10.4.20",
|
|
46
|
+
"tailwindcss": "^3.4.17",
|
|
47
|
+
"typescript": "^5.7.2",
|
|
48
|
+
"vite-tsconfig-paths": "^5.1.4"
|
|
49
|
+
}
|
|
50
|
+
}
|