create-ardo 2.1.1 → 2.2.0

package/dist/index.js

@@ -31,7 +31,14 @@ function createProjectStructure(root, template, options) {
     PROJECT_NAME: options.projectName,
     ARDO_VERSION: getCliVersion(),
     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"
+    GITHUB_PAGES_CONFIG: options.githubPages ? "// GitHub Pages: base path auto-detected from git remote" : "githubPages: false, // Disabled for non-GitHub Pages deployment",
+    GITHUB_PAGES_BASENAME_IMPORT: options.githubPages ? 'import { detectGitHubBasename } from "ardo/vite"' : "",
+    GITHUB_PAGES_BASENAME: options.githubPages ? "basename: detectGitHubBasename()," : "// basename: detectGitHubBasename(), // Uncomment for GitHub Pages",
+    DESCRIPTION: options.description,
+    TYPEDOC_NAV: options.typedoc ? "{ text: 'API', link: '/api-reference' }," : "",
+    TYPEDOC_SIDEBAR: options.typedoc ? "{ text: 'API Reference', link: '/api-reference' }," : "",
+    TYPEDOC_NAVLINK: options.typedoc ? '<NavLink to="/api-reference">API</NavLink>' : "",
+    TYPEDOC_SIDEBARLINK: options.typedoc ? '<SidebarLink to="/api-reference">API Reference</SidebarLink>' : ""
   };
   copyDir(templateDir, root, vars);
 }
@@ -73,6 +80,19 @@ function emptyDir(dir) {
 function isValidTemplate(template) {
   return templates.some((t) => t.name === template);
 }
+function detectProjectDescription(targetDir) {
+  for (const dir of [path.dirname(targetDir), targetDir]) {
+    const pkgPath = path.join(dir, "package.json");
+    try {
+      const pkg = JSON.parse(fs.readFileSync(pkgPath, "utf-8"));
+      if (pkg.description) {
+        return pkg.description;
+      }
+    } catch {
+    }
+  }
+  return void 0;
+}
 
 // src/index.ts
 var defaultTargetDir = "my-docs";
@@ -185,11 +205,13 @@ async function main() {
   console.log();
   console.log(`  ${cyan("Scaffolding project in")} ${root}...`);
   console.log();
+  const description = detectProjectDescription(root) || "Built with Ardo";
   createProjectStructure(root, template, {
     siteTitle,
     projectName: targetDir,
     typedoc: docType === "library",
-    githubPages: githubPages ?? true
+    githubPages: githubPages ?? true,
+    description
   });
   console.log(`  ${green("Done!")} Now run:`);
   console.log();

package/package.json

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

package/templates/minimal/_gitignore

@@ -5,3 +5,7 @@ build
 
 # React Router generated files
 .react-router
+
+# Ardo generated files
+app/routes.ts
+app/routes/api-reference/

package/templates/minimal/app/root.tsx

@@ -46,6 +46,7 @@ export default function Root() {
             nav={
               <Nav>
                 <NavLink to="/guide/getting-started">Guide</NavLink>
+                {{TYPEDOC_NAVLINK}}
               </Nav>
             }
           />
@@ -56,6 +57,7 @@ export default function Root() {
               <SidebarGroup title="Guide">
                 <SidebarLink to="/guide/getting-started">Getting Started</SidebarLink>
               </SidebarGroup>
+              {{TYPEDOC_SIDEBARLINK}}
             </Sidebar>
           )
         }

package/templates/minimal/react-router.config.ts

@@ -1,6 +1,8 @@
 import type { Config } from "@react-router/dev/config"
+{{GITHUB_PAGES_BASENAME_IMPORT}}
 
 export default {
   ssr: false,
   prerender: true,
+  {{GITHUB_PAGES_BASENAME}}
 } satisfies Config

package/templates/minimal/vite.config.ts

@@ -5,7 +5,7 @@ export default defineConfig({
   plugins: [
     ardo({
       title: '{{SITE_TITLE}}',
-      description: 'Built with Ardo',
+      description: '{{DESCRIPTION}}',
 
       {{TYPEDOC_CONFIG}}
 
@@ -14,13 +14,17 @@ export default defineConfig({
       themeConfig: {
         siteTitle: '{{SITE_TITLE}}',
 
-        nav: [{ text: 'Guide', link: '/guide/getting-started' }],
+        nav: [
+          { text: 'Guide', link: '/guide/getting-started' },
+          {{TYPEDOC_NAV}}
+        ],
 
         sidebar: [
           {
             text: 'Guide',
             items: [{ text: 'Getting Started', link: '/guide/getting-started' }],
           },
+          {{TYPEDOC_SIDEBAR}}
         ],
 
         footer: {