create-ardo 1.0.0 → 1.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Sebastian Software GmbH
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.js

@@ -1,10 +1,17 @@
 #!/usr/bin/env node
 
 // src/index.ts
-import fs from "fs";
-import path from "path";
+import fs2 from "fs";
+import path2 from "path";
 import prompts from "prompts";
 import { blue, cyan, green, red, reset, yellow } from "kolorist";
+
+// src/scaffold.ts
+import fs from "fs";
+import path from "path";
+import { fileURLToPath } from "url";
+var __dirname = path.dirname(fileURLToPath(import.meta.url));
+var templatesRoot = path.resolve(__dirname, "..", "templates");
 var templates = [
   {
     name: "minimal",
@@ -12,6 +19,54 @@ var templates = [
     description: "Basic setup with essential files only"
   }
 ];
+function createProjectStructure(root, template, siteTitle, projectName) {
+  const templateDir = path.join(templatesRoot, template);
+  const vars = {
+    SITE_TITLE: siteTitle,
+    PROJECT_NAME: projectName
+  };
+  copyDir(templateDir, root, vars);
+}
+function copyDir(src, dest, vars) {
+  fs.mkdirSync(dest, { recursive: true });
+  for (const entry of fs.readdirSync(src, { withFileTypes: true })) {
+    const srcPath = path.join(src, entry.name);
+    const destName = entry.name === "_gitignore" ? ".gitignore" : entry.name;
+    const destPath = path.join(dest, destName);
+    if (entry.isDirectory()) {
+      copyDir(srcPath, destPath, vars);
+    } else {
+      let content = fs.readFileSync(srcPath, "utf-8");
+      for (const [key, value] of Object.entries(vars)) {
+        content = content.replaceAll(`{{${key}}}`, value);
+      }
+      fs.writeFileSync(destPath, content);
+    }
+  }
+}
+function formatTargetDir(targetDir) {
+  return targetDir?.trim().replace(/\/+$/g, "");
+}
+function isEmpty(dirPath) {
+  const files = fs.readdirSync(dirPath);
+  return files.length === 0 || files.length === 1 && files[0] === ".git";
+}
+function emptyDir(dir) {
+  if (!fs.existsSync(dir)) {
+    return;
+  }
+  for (const file of fs.readdirSync(dir)) {
+    if (file === ".git") {
+      continue;
+    }
+    fs.rmSync(path.join(dir, file), { recursive: true, force: true });
+  }
+}
+function isValidTemplate(template) {
+  return templates.some((t) => t.name === template);
+}
+
+// src/index.ts
 var defaultTargetDir = "my-docs";
 async function main() {
   console.log();
@@ -33,7 +88,7 @@ async function main() {
         }
       },
       {
-        type: () => !fs.existsSync(targetDir) || isEmpty(targetDir) ? null : "select",
+        type: () => !fs2.existsSync(targetDir) || isEmpty(targetDir) ? null : "select",
         name: "overwrite",
         message: () => `${targetDir === "." ? "Current directory" : `Target directory "${targetDir}"`} is not empty. How would you like to proceed?`,
         choices: [
@@ -75,11 +130,11 @@ async function main() {
   );
   const { overwrite, template: templateChoice, siteTitle } = response;
   template = templateChoice || template || "minimal";
-  const root = path.join(process.cwd(), targetDir);
+  const root = path2.join(process.cwd(), targetDir);
   if (overwrite === "yes") {
     emptyDir(root);
-  } else if (!fs.existsSync(root)) {
-    fs.mkdirSync(root, { recursive: true });
+  } else if (!fs2.existsSync(root)) {
+    fs2.mkdirSync(root, { recursive: true });
   }
   console.log();
   console.log(`  ${cyan("Scaffolding project in")} ${root}...`);
@@ -94,171 +149,6 @@ async function main() {
   console.log(`  ${blue("pnpm dev")}`);
   console.log();
 }
-function createProjectStructure(root, _template, siteTitle, projectName) {
-  const pkg = {
-    name: projectName,
-    version: "0.0.0",
-    private: true,
-    type: "module",
-    scripts: {
-      dev: "vite",
-      build: "vite build",
-      preview: "vite preview"
-    },
-    dependencies: {
-      ardo: "^1.0.0",
-      react: "^19.0.0",
-      "react-dom": "^19.0.0"
-    },
-    devDependencies: {
-      "@types/react": "^19.0.0",
-      "@types/react-dom": "^19.0.0",
-      typescript: "^5.7.0",
-      vite: "^6.0.0"
-    }
-  };
-  fs.writeFileSync(path.join(root, "package.json"), JSON.stringify(pkg, null, 2) + "\n");
-  const tsconfig = {
-    compilerOptions: {
-      target: "ES2022",
-      lib: ["ES2022", "DOM", "DOM.Iterable"],
-      module: "ESNext",
-      moduleResolution: "bundler",
-      resolveJsonModule: true,
-      allowImportingTsExtensions: true,
-      strict: true,
-      noEmit: true,
-      esModuleInterop: true,
-      skipLibCheck: true,
-      forceConsistentCasingInFileNames: true,
-      jsx: "react-jsx"
-    },
-    include: ["src/**/*", "*.ts", "*.config.ts"],
-    exclude: ["node_modules", "dist"]
-  };
-  fs.writeFileSync(path.join(root, "tsconfig.json"), JSON.stringify(tsconfig, null, 2) + "\n");
-  const viteConfig = `import { defineConfig } from 'vite'
-import { ardo } from 'ardo/vite'
-
-export default defineConfig({
-  plugins: [
-    ardo({
-      title: '${siteTitle}',
-      description: 'Built with Ardo',
-
-      themeConfig: {
-        siteTitle: '${siteTitle}',
-
-        nav: [
-          { text: 'Guide', link: '/guide/getting-started' },
-        ],
-
-        sidebar: [
-          {
-            text: 'Guide',
-            items: [
-              { text: 'Getting Started', link: '/guide/getting-started' },
-            ],
-          },
-        ],
-
-        footer: {
-          message: 'Built with Ardo',
-        },
-
-        search: {
-          enabled: true,
-        },
-      },
-    }),
-  ],
-})
-`;
-  fs.writeFileSync(path.join(root, "vite.config.ts"), viteConfig);
-  const gitignore = `node_modules
-dist
-.DS_Store
-*.local
-`;
-  fs.writeFileSync(path.join(root, ".gitignore"), gitignore);
-  const contentDir = path.join(root, "content");
-  const guideDir = path.join(contentDir, "guide");
-  fs.mkdirSync(guideDir, { recursive: true });
-  const indexMd = `---
-title: Welcome
----
-
-# Welcome to ${siteTitle}
-
-This documentation site is built with [Ardo](https://github.com/sebastian-software/ardo).
-
-## Getting Started
-
-Check out the [Getting Started](/guide/getting-started) guide to learn more.
-`;
-  fs.writeFileSync(path.join(contentDir, "index.md"), indexMd);
-  const gettingStartedMd = `---
-title: Getting Started
----
-
-# Getting Started
-
-Welcome to your new documentation site!
-
-## Development
-
-\`\`\`bash
-# Start development server
-pnpm dev
-
-# Build for production
-pnpm build
-
-# Preview production build
-pnpm preview
-\`\`\`
-
-## Adding Content
-
-Create \`.md\` or \`.mdx\` files in the \`content/\` directory. They will automatically become pages.
-
-## Configuration
-
-Edit \`vite.config.ts\` to customize your site:
-
-- Navigation links
-- Sidebar structure
-- Site title and description
-- Theme options
-
-## Learn More
-
-- [Ardo Documentation](https://sebastian-software.github.io/ardo/)
-- [GitHub Repository](https://github.com/sebastian-software/ardo)
-`;
-  fs.writeFileSync(path.join(guideDir, "getting-started.md"), gettingStartedMd);
-}
-function formatTargetDir(targetDir) {
-  return targetDir?.trim().replace(/\/+$/g, "");
-}
-function isEmpty(dirPath) {
-  const files = fs.readdirSync(dirPath);
-  return files.length === 0 || files.length === 1 && files[0] === ".git";
-}
-function emptyDir(dir) {
-  if (!fs.existsSync(dir)) {
-    return;
-  }
-  for (const file of fs.readdirSync(dir)) {
-    if (file === ".git") {
-      continue;
-    }
-    fs.rmSync(path.join(dir, file), { recursive: true, force: true });
-  }
-}
-function isValidTemplate(template) {
-  return templates.some((t) => t.name === template);
-}
 main().catch((e) => {
   console.error(e.message);
   process.exit(1);

package/package.json

@@ -1,19 +1,15 @@
 {
   "name": "create-ardo",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Scaffolding tool for Ardo documentation projects",
   "type": "module",
   "bin": {
     "create-ardo": "./dist/index.js"
   },
   "files": [
-    "dist"
+    "dist",
+    "templates"
   ],
-  "scripts": {
-    "build": "tsup",
-    "dev": "tsup --watch",
-    "typecheck": "tsc --noEmit"
-  },
   "keywords": [
     "ardo",
     "create",
@@ -44,5 +40,10 @@
   },
   "engines": {
     "node": ">=18.0.0"
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "typecheck": "tsc --noEmit"
   }
-}
+}

package/templates/minimal/.github/workflows/deploy.yml

@@ -0,0 +1,56 @@
+name: Deploy to GitHub Pages
+
+on:
+  push:
+    branches: [main]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: 'pages'
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '22'
+          cache: 'pnpm'
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile
+
+      - name: Build
+        run: pnpm build
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v4
+        with:
+          path: dist/client
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

package/templates/minimal/_gitignore

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

package/templates/minimal/content/guide/getting-started.md

@@ -0,0 +1,38 @@
+---
+title: Getting Started
+---
+
+# Getting Started
+
+Welcome to your new documentation site!
+
+## Development
+
+```bash
+# Start development server
+pnpm dev
+
+# Build for production
+pnpm build
+
+# Preview production build
+pnpm preview
+```
+
+## Adding Content
+
+Create `.md` or `.mdx` files in the `content/` directory. They will automatically become pages.
+
+## Configuration
+
+Edit `vite.config.ts` to customize your site:
+
+- Navigation links
+- Sidebar structure
+- Site title and description
+- Theme options
+
+## Learn More
+
+- [Ardo Documentation](https://sebastian-software.github.io/ardo/)
+- [GitHub Repository](https://github.com/sebastian-software/ardo)

package/templates/minimal/content/index.md

@@ -0,0 +1,18 @@
+---
+title: Welcome
+hero:
+  name: '{{SITE_TITLE}}'
+  text: Documentation Made Simple
+  tagline: Focus on your content, not configuration
+  actions:
+    - text: Get Started
+      link: /guide/getting-started
+      theme: brand
+features:
+  - title: Zero Config
+    details: Just write markdown. No framework knowledge required.
+  - title: Fast
+    details: Powered by Vite and React 19.
+  - title: Beautiful
+    details: Clean design out of the box.
+---

package/templates/minimal/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "{{PROJECT_NAME}}",
+  "version": "0.0.0",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "dev": "vite",
+    "build": "vite build",
+    "preview": "vite preview"
+  },
+  "dependencies": {
+    "@tanstack/react-router": "*",
+    "@tanstack/react-start": "*",
+    "ardo": "^1.0.0",
+    "react": "*",
+    "react-dom": "*"
+  },
+  "devDependencies": {
+    "@types/react": "^19.0.0",
+    "@types/react-dom": "^19.0.0",
+    "typescript": "^5.7.0",
+    "vite": "^8.0.0-beta.0"
+  }
+}

package/templates/minimal/src/router.tsx

@@ -0,0 +1,18 @@
+import { createRouter } from '@tanstack/react-router'
+import { routeTree } from './routeTree.gen'
+
+export function getRouter() {
+  return createRouter({
+    routeTree,
+    scrollRestoration: true,
+    defaultPreloadStaleTime: 0,
+  })
+}
+
+export type AppRouter = ReturnType<typeof getRouter>
+
+declare module '@tanstack/react-router' {
+  interface Register {
+    router: AppRouter
+  }
+}

package/templates/minimal/src/routes/(docs)/_layout.tsx

@@ -0,0 +1,19 @@
+import { createFileRoute, Outlet } from '@tanstack/react-router'
+import { DocLayout } 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,
+})
+
+function DocsLayoutComponent() {
+  return (
+    <PressProvider config={config} sidebar={sidebar}>
+      <DocLayout>
+        <Outlet />
+      </DocLayout>
+    </PressProvider>
+  )
+}

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

@@ -0,0 +1,29 @@
+import { createRootRoute, HeadContent, Scripts } from '@tanstack/react-router'
+import config from 'virtual:ardo/config'
+import 'ardo/theme/styles.css'
+
+export const Route = createRootRoute({
+  head: () => ({
+    meta: [
+      { charSet: 'utf-8' },
+      { name: 'viewport', content: 'width=device-width, initial-scale=1' },
+      { title: config.title },
+      { name: 'description', content: config.description },
+    ],
+  }),
+  shellComponent: RootDocument,
+})
+
+function RootDocument({ children }: { children: React.ReactNode }) {
+  return (
+    <html lang="en" suppressHydrationWarning>
+      <head>
+        <HeadContent />
+      </head>
+      <body suppressHydrationWarning>
+        {children}
+        <Scripts />
+      </body>
+    </html>
+  )
+}

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

@@ -0,0 +1,39 @@
+import { createFileRoute } from '@tanstack/react-router'
+import { HomePage } from 'ardo/theme'
+import { PressProvider } from 'ardo/runtime'
+import config from 'virtual:ardo/config'
+import sidebar from 'virtual:ardo/sidebar'
+import { frontmatter, toc } from '../../content/index.md'
+
+export const Route = createFileRoute('/')({
+  head: () => ({
+    meta: [
+      {
+        title: (frontmatter.title as string)
+          ? `${frontmatter.title} | ${config.title}`
+          : config.title,
+      },
+      ...(frontmatter.description
+        ? [{ name: 'description', content: frontmatter.description as string }]
+        : []),
+    ],
+  }),
+  component: HomeComponent,
+})
+
+function HomeComponent() {
+  const pageData = {
+    title: (frontmatter.title as string) || 'Home',
+    description: frontmatter.description as string | undefined,
+    frontmatter,
+    toc,
+    filePath: 'index.md',
+    relativePath: 'index.md',
+  }
+
+  return (
+    <PressProvider config={config} sidebar={sidebar} currentPage={pageData}>
+      <HomePage />
+    </PressProvider>
+  )
+}

package/templates/minimal/src/vite-env.d.ts

@@ -0,0 +1,23 @@
+/// <reference types="vite/client" />
+
+declare module 'virtual:ardo/config' {
+  import type { PressConfig } from 'ardo'
+  const config: PressConfig
+  export default config
+}
+
+declare module 'virtual:ardo/sidebar' {
+  import type { SidebarItem } from 'ardo'
+  const sidebar: SidebarItem[]
+  export default sidebar
+}
+
+declare module '*.md' {
+  import type { ComponentType } from 'react'
+  import type { PageFrontmatter, TOCItem } from 'ardo'
+
+  export const frontmatter: PageFrontmatter
+  export const toc: TOCItem[]
+  const component: ComponentType
+  export default component
+}

package/templates/minimal/tsconfig.json

@@ -0,0 +1,18 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "lib": ["ES2022", "DOM", "DOM.Iterable"],
+    "module": "ESNext",
+    "moduleResolution": "bundler",
+    "resolveJsonModule": true,
+    "allowImportingTsExtensions": true,
+    "strict": true,
+    "noEmit": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "jsx": "react-jsx"
+  },
+  "include": ["src/**/*", "*.ts", "*.config.ts"],
+  "exclude": ["node_modules", "dist"]
+}

package/templates/minimal/vite.config.ts

@@ -0,0 +1,35 @@
+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',
+
+      themeConfig: {
+        siteTitle: '{{SITE_TITLE}}',
+
+        nav: [{ text: 'Guide', link: '/guide/getting-started' }],
+
+        sidebar: [
+          {
+            text: 'Guide',
+            items: [{ text: 'Getting Started', link: '/guide/getting-started' }],
+          },
+        ],
+
+        footer: {
+          message: 'Built with Ardo',
+        },
+
+        search: {
+          enabled: true,
+        },
+      },
+    }),
+  ],
+})