create-ardo 3.2.0 → 3.3.0

package/README.md

@@ -1,50 +1,60 @@
 # create-ardo
 
-Scaffolding tool for [Ardo](https://github.com/sebastian-software/ardo) documentation projects.
+Scaffold a modern, open Ardo documentation site for React teams.
+
+`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.
 
 ## Usage
 
 ```bash
-# With npm
+# npm
 npm create ardo@latest
 
-# With pnpm
+# pnpm
 pnpm create ardo@latest
 
-# With yarn
+# yarn
 yarn create ardo
 
-# With bun
+# bun
 bun create ardo
 ```
 
 ### Specify project name
 
 ```bash
-npm create ardo@latest my-docs
+pnpm create ardo@latest my-docs
 ```
 
 ### Non-interactive
 
 ```bash
-npm create ardo@latest my-docs minimal
+pnpm create ardo@latest my-docs minimal
 ```
 
-## What's Created
+## What gets created
 
-```
+```text
 my-docs/
-├── content/
-│   ├── index.md
-│   └── guide/
-│       └── getting-started.md
-├── vite.config.ts
+├── .github/
+│   └── workflows/
+│       └── deploy.yml          # GitHub Pages deployment
+├── app/
+│   ├── app.css                 # Tailwind v4 utility layers
+│   ├── entry.client.tsx
+│   ├── entry.server.tsx
+│   ├── root.tsx                # ArdoRoot + React Router shell
+│   ├── routes.ts
+│   └── routes/
+│       └── home.tsx
+├── vite.config.ts              # Vite + ardo() plugin
+├── react-router.config.ts      # Static prerender config
 ├── tsconfig.json
 ├── package.json
-└── .gitignore
+└── pnpm-workspace.yaml
 ```
 
-## After Creation
+## After creation
 
 ```bash
 cd my-docs
@@ -52,6 +62,8 @@ pnpm install
 pnpm dev
 ```
 
+Open `http://localhost:5173`, add MDX files under `app/routes/`, and Ardo will include them in the generated docs navigation.
+
 ## License
 
 [MIT](../../LICENSE) © [Sebastian Software GmbH](https://sebastian-software.de)

package/dist/index.js

@@ -170,7 +170,7 @@ async function promptProjectName() {
 		name: "projectName",
 		message: reset("Project name:"),
 		initial: defaultTargetDir,
-		validate: (value) => {
+		validate(value) {
 			const name = value.trim();
 			if (!name) return "Project name is required";
 			if (/^[.-]/.test(name)) return "Project name cannot start with a dot or hyphen";
@@ -223,7 +223,7 @@ function getNewProjectPrompts(targetDir, root, argTemplate) {
 			]
 		},
 		{
-			type: (_, { overwrite }) => {
+			type(_, { overwrite }) {
 				if (overwrite === "no") throw new Error(`${red("✖")} Operation cancelled`);
 				return null;
 			},
@@ -271,7 +271,7 @@ function getNewProjectPrompts(targetDir, root, argTemplate) {
 	];
 }
 async function runNewProjectFlow(targetDir, root, argTemplate) {
-	const response = await prompts(getNewProjectPrompts(targetDir, root, argTemplate), { onCancel });
+	const response = readNewProjectPromptResponse(await prompts(getNewProjectPrompts(targetDir, root, argTemplate), { onCancel }));
 	const template = response.template ?? argTemplate ?? "minimal";
 	if (response.overwrite === "yes") emptyDir(root);
 	else if (!fs.existsSync(root)) fs.mkdirSync(root, { recursive: true });
@@ -288,6 +288,25 @@ async function runNewProjectFlow(targetDir, root, argTemplate) {
 	console.log(`  ${blue("pnpm install")}`);
 	console.log(`  ${blue("pnpm dev")}\n`);
 }
+function readNewProjectPromptResponse(data) {
+	if (!isRecord(data)) return {
+		docType: "general",
+		siteTitle: "My Documentation"
+	};
+	return {
+		docType: data.docType === "library" ? "library" : "general",
+		githubPages: typeof data.githubPages === "boolean" ? data.githubPages : void 0,
+		overwrite: readOverwrite(data.overwrite),
+		siteTitle: typeof data.siteTitle === "string" ? data.siteTitle : "My Documentation",
+		template: typeof data.template === "string" ? data.template : void 0
+	};
+}
+function readOverwrite(value) {
+	return value === "ignore" || value === "no" || value === "yes" ? value : void 0;
+}
+function isRecord(value) {
+	return value != null && typeof value === "object";
+}
 async function main() {
 	console.log(`\n  ${cyan("◆")} ${green("create-ardo")}\n`);
 	const argTargetDir = process.argv.length > 2 ? process.argv[2] : void 0;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-ardo",
-  "version": "3.2.0",
+  "version": "3.3.0",
   "description": "Scaffolding tool for Ardo documentation projects",
   "type": "module",
   "bin": {
@@ -29,14 +29,15 @@
     "url": "https://github.com/sebastian-software/ardo/issues"
   },
   "dependencies": {
-    "prompts": "^2.4.2",
-    "kolorist": "^1.8.0"
+    "kolorist": "^1.8.0",
+    "prompts": "^2.4.2"
   },
   "devDependencies": {
-    "@types/node": "^25.5.0",
+    "@types/node": "^25.6.1",
     "@types/prompts": "^2.4.9",
-    "tsdown": "^0.21.7",
-    "typescript": "^6.0.2"
+    "tsdown": "^0.22.0",
+    "typescript": "^6.0.3",
+    "vitest": "^4.1.5"
   },
   "engines": {
     "node": ">=18.0.0"

package/templates/minimal/package.json

@@ -11,18 +11,18 @@
   "dependencies": {
     "ardo": "^{{ARDO_VERSION}}",
     "isbot": "^5.1.36",
-    "lucide-react": "^0.577.0",
+    "lucide-react": "^1.14.0",
     "react": "^19.2.4",
     "react-dom": "^19.2.4",
     "react-router": "^7.13.2"
   },
   "devDependencies": {
-    "@react-router/dev": "^7.13.2",
-    "@tailwindcss/vite": "^4.2.2",
+    "@react-router/dev": "^7.15.0",
+    "@tailwindcss/vite": "^4.2.4",
     "@types/react": "^19.2.14",
     "@types/react-dom": "^19.2.3",
-    "tailwindcss": "^4.2.2",
-    "typescript": "^6.0.2",
-    "vite": "^8.0.3"
+    "tailwindcss": "^4.2.4",
+    "typescript": "^6.0.3",
+    "vite": "^8.0.11"
   }
 }

package/templates/minimal/pnpm-workspace.yaml

@@ -0,0 +1,8 @@
+packages:
+  - "."
+
+allowBuilds:
+  esbuild: true
+
+onlyBuiltDependencies:
+  - esbuild