create-ardo 1.1.2 → 1.2.0

package/dist/index.js

@@ -4,7 +4,7 @@
 import fs2 from "fs";
 import path2 from "path";
 import prompts from "prompts";
-import { blue, cyan, green, red, reset, yellow } from "kolorist";
+import { blue, cyan, green, red, reset, yellow, dim } from "kolorist";
 
 // src/scaffold.ts
 import fs from "fs";
@@ -19,11 +19,13 @@ var templates = [
     description: "Basic setup with essential files only"
   }
 ];
-function createProjectStructure(root, template, siteTitle, projectName) {
+function createProjectStructure(root, template, options) {
   const templateDir = path.join(templatesRoot, template);
   const vars = {
-    SITE_TITLE: siteTitle,
-    PROJECT_NAME: projectName
+    SITE_TITLE: options.siteTitle,
+    PROJECT_NAME: options.projectName,
+    TYPEDOC_CONFIG: options.typedoc ? "typedoc: true," : "// typedoc: true, // Uncomment to enable API docs",
+    GITHUB_PAGES_CONFIG: options.githubPages ? "// GitHub Pages: base path auto-detected from git remote" : "githubPages: false, // Disabled for non-GitHub Pages deployment"
   };
   copyDir(templateDir, root, vars);
 }
@@ -120,6 +122,36 @@ async function main() {
         name: "siteTitle",
         message: reset("Site title:"),
         initial: "My Documentation"
+      },
+      {
+        type: "select",
+        name: "docType",
+        message: reset("What are you documenting?"),
+        choices: [
+          {
+            title: `Code library ${dim("- includes TypeDoc API generation")}`,
+            value: "library"
+          },
+          {
+            title: `General documentation ${dim("- guides, manuals, etc.")}`,
+            value: "general"
+          }
+        ]
+      },
+      {
+        type: "select",
+        name: "githubPages",
+        message: reset("Deploy to GitHub Pages?"),
+        choices: [
+          {
+            title: `Yes ${dim("- auto-detects base path from git remote")}`,
+            value: true
+          },
+          {
+            title: `No ${dim("- deploy to other platforms (Netlify, Vercel, etc.)")}`,
+            value: false
+          }
+        ]
       }
     ],
     {
@@ -128,7 +160,7 @@ async function main() {
       }
     }
   );
-  const { overwrite, template: templateChoice, siteTitle } = response;
+  const { overwrite, template: templateChoice, siteTitle, docType, githubPages } = response;
   template = templateChoice || template || "minimal";
   const root = path2.join(process.cwd(), targetDir);
   if (overwrite === "yes") {
@@ -139,7 +171,12 @@ async function main() {
   console.log();
   console.log(`  ${cyan("Scaffolding project in")} ${root}...`);
   console.log();
-  createProjectStructure(root, template, siteTitle, targetDir);
+  createProjectStructure(root, template, {
+    siteTitle,
+    projectName: targetDir,
+    typedoc: docType === "library",
+    githubPages: githubPages ?? true
+  });
   console.log(`  ${green("Done!")} Now run:`);
   console.log();
   if (root !== process.cwd()) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-ardo",
-  "version": "1.1.2",
+  "version": "1.2.0",
   "description": "Scaffolding tool for Ardo documentation projects",
   "type": "module",
   "bin": {

package/templates/minimal/_gitignore

@@ -3,7 +3,7 @@ dist
 .DS_Store
 *.local
 
-# Auto-generated by ardo (content routes derived from markdown/TypeDoc)
-src/routes/(docs)/**/*.tsx
-!src/routes/(docs)/_layout.tsx
+# Auto-generated by ardo (content routes derived from markdown)
+src/routes/guide/*.tsx
+!src/routes/guide/_layout.tsx
 src/routeTree.gen.ts

package/templates/minimal/package.json

@@ -11,14 +11,14 @@
   "dependencies": {
     "@tanstack/react-router": "*",
     "@tanstack/react-start": "*",
-    "ardo": "^1.0.0",
+    "ardo": "^1.1.1",
     "react": "*",
     "react-dom": "*"
   },
   "devDependencies": {
-    "@types/react": "^19.0.0",
-    "@types/react-dom": "^19.0.0",
-    "typescript": "^5.7.0",
+    "@types/react": "^19.2.10",
+    "@types/react-dom": "^19.2.3",
+    "typescript": "^5.9.3",
     "vite": "^8.0.0-beta.0"
   }
 }

package/templates/minimal/src/routes/{(docs) → guide}/_layout.tsx

@@ -1,19 +1,19 @@
 import { createFileRoute, Outlet } from '@tanstack/react-router'
-import { DocLayout } from 'ardo/theme'
+import { Layout } from 'ardo/theme'
 import { PressProvider } from 'ardo/runtime'
 import config from 'virtual:ardo/config'
 import sidebar from 'virtual:ardo/sidebar'
 
-export const Route = createFileRoute('/(docs)/_layout')({
-  component: DocsLayoutComponent,
+export const Route = createFileRoute('/guide/_layout')({
+  component: GuideLayoutComponent,
 })
 
-function DocsLayoutComponent() {
+function GuideLayoutComponent() {
   return (
     <PressProvider config={config} sidebar={sidebar}>
-      <DocLayout>
+      <Layout>
         <Outlet />
-      </DocLayout>
+      </Layout>
     </PressProvider>
   )
 }

package/templates/minimal/src/routes/index.tsx

@@ -26,6 +26,7 @@ function HomeComponent() {
     title: (frontmatter.title as string) || 'Home',
     description: frontmatter.description as string | undefined,
     frontmatter,
+    content: '',
     toc,
     filePath: 'index.md',
     relativePath: 'index.md',

package/templates/minimal/vite.config.ts

@@ -2,14 +2,15 @@ import { defineConfig } from 'vite'
 import { ardo } from 'ardo/vite'
 
 export default defineConfig({
-  // For GitHub Pages subdirectory deployments, uncomment and adjust:
-  // base: '/{{PROJECT_NAME}}/',
-
   plugins: [
     ardo({
       title: '{{SITE_TITLE}}',
       description: 'Built with Ardo',
 
+      {{TYPEDOC_CONFIG}}
+
+      {{GITHUB_PAGES_CONFIG}}
+
       themeConfig: {
         siteTitle: '{{SITE_TITLE}}',