create-ardo 3.2.1 → 3.3.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 +28 -16
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,50 +1,60 @@
|
|
|
1
1
|
# create-ardo
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Scaffold a modern, open Ardo documentation site for React teams.
|
|
4
|
+
|
|
5
|
+
`create-ardo` creates a working React Router + Vite + Ardo project with MDX-ready routes, Tailwind CSS v4, static prerendering, and an optional GitHub Pages workflow. It is the fastest way to start writing docs without hand-assembling the React Router shell.
|
|
4
6
|
|
|
5
7
|
## Usage
|
|
6
8
|
|
|
7
9
|
```bash
|
|
8
|
-
#
|
|
10
|
+
# npm
|
|
9
11
|
npm create ardo@latest
|
|
10
12
|
|
|
11
|
-
#
|
|
13
|
+
# pnpm
|
|
12
14
|
pnpm create ardo@latest
|
|
13
15
|
|
|
14
|
-
#
|
|
16
|
+
# yarn
|
|
15
17
|
yarn create ardo
|
|
16
18
|
|
|
17
|
-
#
|
|
19
|
+
# bun
|
|
18
20
|
bun create ardo
|
|
19
21
|
```
|
|
20
22
|
|
|
21
23
|
### Specify project name
|
|
22
24
|
|
|
23
25
|
```bash
|
|
24
|
-
|
|
26
|
+
pnpm create ardo@latest my-docs
|
|
25
27
|
```
|
|
26
28
|
|
|
27
29
|
### Non-interactive
|
|
28
30
|
|
|
29
31
|
```bash
|
|
30
|
-
|
|
32
|
+
pnpm create ardo@latest my-docs minimal
|
|
31
33
|
```
|
|
32
34
|
|
|
33
|
-
## What
|
|
35
|
+
## What gets created
|
|
34
36
|
|
|
35
|
-
```
|
|
37
|
+
```text
|
|
36
38
|
my-docs/
|
|
37
|
-
├──
|
|
38
|
-
│
|
|
39
|
-
│
|
|
40
|
-
|
|
41
|
-
├──
|
|
39
|
+
├── .github/
|
|
40
|
+
│ └── workflows/
|
|
41
|
+
│ └── deploy.yml # GitHub Pages deployment
|
|
42
|
+
├── app/
|
|
43
|
+
│ ├── app.css # Tailwind v4 utility layers
|
|
44
|
+
│ ├── entry.client.tsx
|
|
45
|
+
│ ├── entry.server.tsx
|
|
46
|
+
│ ├── root.tsx # ArdoRoot + React Router shell
|
|
47
|
+
│ ├── routes.ts
|
|
48
|
+
│ └── routes/
|
|
49
|
+
│ └── home.tsx
|
|
50
|
+
├── vite.config.ts # Vite + ardo() plugin
|
|
51
|
+
├── react-router.config.ts # Static prerender config
|
|
42
52
|
├── tsconfig.json
|
|
43
53
|
├── package.json
|
|
44
|
-
└── .
|
|
54
|
+
└── pnpm-workspace.yaml
|
|
45
55
|
```
|
|
46
56
|
|
|
47
|
-
## After
|
|
57
|
+
## After creation
|
|
48
58
|
|
|
49
59
|
```bash
|
|
50
60
|
cd my-docs
|
|
@@ -52,6 +62,8 @@ pnpm install
|
|
|
52
62
|
pnpm dev
|
|
53
63
|
```
|
|
54
64
|
|
|
65
|
+
Open `http://localhost:5173`, add MDX files under `app/routes/`, and Ardo will include them in the generated docs navigation.
|
|
66
|
+
|
|
55
67
|
## License
|
|
56
68
|
|
|
57
69
|
[MIT](../../LICENSE) © [Sebastian Software GmbH](https://sebastian-software.de)
|