create-ardo 1.0.0

package/README.md

@@ -0,0 +1,57 @@
+# create-ardo
+
+Scaffolding tool for [Ardo](https://github.com/sebastian-software/ardo) documentation projects.
+
+## Usage
+
+```bash
+# With npm
+npm create ardo@latest
+
+# With pnpm
+pnpm create ardo@latest
+
+# With yarn
+yarn create ardo
+
+# With bun
+bun create ardo
+```
+
+### Specify project name
+
+```bash
+npm create ardo@latest my-docs
+```
+
+### Non-interactive
+
+```bash
+npm create ardo@latest my-docs minimal
+```
+
+## What's Created
+
+```
+my-docs/
+├── content/
+│   ├── index.md
+│   └── guide/
+│       └── getting-started.md
+├── vite.config.ts
+├── tsconfig.json
+├── package.json
+└── .gitignore
+```
+
+## After Creation
+
+```bash
+cd my-docs
+pnpm install
+pnpm dev
+```
+
+## License
+
+[MIT](../../LICENSE) © [Sebastian Software GmbH](https://sebastian-software.de)

package/dist/index.js

@@ -0,0 +1,265 @@
+#!/usr/bin/env node
+
+// src/index.ts
+import fs from "fs";
+import path from "path";
+import prompts from "prompts";
+import { blue, cyan, green, red, reset, yellow } from "kolorist";
+var templates = [
+  {
+    name: "minimal",
+    display: "Minimal",
+    description: "Basic setup with essential files only"
+  }
+];
+var defaultTargetDir = "my-docs";
+async function main() {
+  console.log();
+  console.log(`  ${cyan("\u25C6")} ${green("create-ardo")}`);
+  console.log();
+  const argTargetDir = process.argv[2];
+  const argTemplate = process.argv[3];
+  let targetDir = argTargetDir || defaultTargetDir;
+  let template = argTemplate;
+  const response = await prompts(
+    [
+      {
+        type: argTargetDir ? null : "text",
+        name: "projectName",
+        message: reset("Project name:"),
+        initial: defaultTargetDir,
+        onState: (state) => {
+          targetDir = formatTargetDir(state.value) || defaultTargetDir;
+        }
+      },
+      {
+        type: () => !fs.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: [
+          { title: "Remove existing files and continue", value: "yes" },
+          { title: "Cancel operation", value: "no" },
+          { title: "Ignore files and continue", value: "ignore" }
+        ]
+      },
+      {
+        type: (_, { overwrite: overwrite2 }) => {
+          if (overwrite2 === "no") {
+            throw new Error(red("\u2716") + " Operation cancelled");
+          }
+          return null;
+        },
+        name: "overwriteChecker"
+      },
+      {
+        type: argTemplate && isValidTemplate(argTemplate) ? null : "select",
+        name: "template",
+        message: reset("Select a template:"),
+        choices: templates.map((t) => ({
+          title: `${t.display} ${yellow(`- ${t.description}`)}`,
+          value: t.name
+        }))
+      },
+      {
+        type: "text",
+        name: "siteTitle",
+        message: reset("Site title:"),
+        initial: "My Documentation"
+      }
+    ],
+    {
+      onCancel: () => {
+        throw new Error(red("\u2716") + " Operation cancelled");
+      }
+    }
+  );
+  const { overwrite, template: templateChoice, siteTitle } = response;
+  template = templateChoice || template || "minimal";
+  const root = path.join(process.cwd(), targetDir);
+  if (overwrite === "yes") {
+    emptyDir(root);
+  } else if (!fs.existsSync(root)) {
+    fs.mkdirSync(root, { recursive: true });
+  }
+  console.log();
+  console.log(`  ${cyan("Scaffolding project in")} ${root}...`);
+  console.log();
+  createProjectStructure(root, template, siteTitle, targetDir);
+  console.log(`  ${green("Done!")} Now run:`);
+  console.log();
+  if (root !== process.cwd()) {
+    console.log(`  ${blue("cd")} ${targetDir}`);
+  }
+  console.log(`  ${blue("pnpm install")}`);
+  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

@@ -0,0 +1,48 @@
+{
+  "name": "create-ardo",
+  "version": "1.0.0",
+  "description": "Scaffolding tool for Ardo documentation projects",
+  "type": "module",
+  "bin": {
+    "create-ardo": "./dist/index.js"
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "typecheck": "tsc --noEmit"
+  },
+  "keywords": [
+    "ardo",
+    "create",
+    "scaffold",
+    "documentation",
+    "cli"
+  ],
+  "author": "Sebastian Software GmbH",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/sebastian-software/ardo.git",
+    "directory": "packages/create-ardo"
+  },
+  "homepage": "https://sebastian-software.github.io/ardo/",
+  "bugs": {
+    "url": "https://github.com/sebastian-software/ardo/issues"
+  },
+  "dependencies": {
+    "prompts": "^2.4.2",
+    "kolorist": "^1.8.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.10.0",
+    "@types/prompts": "^2.4.9",
+    "tsup": "^8.5.1",
+    "typescript": "^5.9.3"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  }
+}