create-docs-engine 2.0.0

package/README.md

@@ -0,0 +1,55 @@
+# create-docs-engine
+
+Scaffold a new docs-engine documentation site with one command.
+
+## Usage
+
+```bash
+npx create-docs-engine my-docs
+cd my-docs
+pnpm dev
+```
+
+## Features
+
+- Interactive CLI prompts for project configuration
+- Support for npm, pnpm, and yarn
+- Optional features (screenshots, mermaid, git integration)
+- Ready-to-run SvelteKit project with docs-engine configured
+- Sample documentation files included
+
+## Options
+
+```bash
+# Specify project name
+npx create-docs-engine my-docs
+
+# Interactive mode (will prompt for project name)
+npx create-docs-engine
+```
+
+## What's Included
+
+The generated project includes:
+
+- `docs/` - Markdown documentation files
+- `src/routes/` - SvelteKit routes
+- Sample markdown files demonstrating features
+- Configured package.json with scripts
+- .gitignore file
+- README.md
+
+## Development
+
+After creating a project:
+
+```bash
+cd my-docs
+pnpm dev        # Start dev server
+pnpm build      # Build for production
+pnpm preview    # Preview production build
+```
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1 @@
+#!/usr/bin/env node

package/dist/index.js

@@ -0,0 +1,220 @@
+#!/usr/bin/env node
+#!/usr/bin/env node
+
+// src/index.ts
+import { promises as fs } from "fs";
+import path from "path";
+import prompts from "prompts";
+import chalk from "chalk";
+import ora from "ora";
+import { execSync } from "child_process";
+async function main() {
+  console.log(chalk.bold.cyan("\n\u{1F680} Create Docs Engine\n"));
+  const args = process.argv.slice(2);
+  let projectName = args[0];
+  if (!projectName) {
+    const response = await prompts({
+      type: "text",
+      name: "projectName",
+      message: "Project name:",
+      initial: "my-docs"
+    });
+    projectName = response.projectName;
+  }
+  if (!projectName) {
+    console.error(chalk.red("\u274C Project name is required"));
+    process.exit(1);
+  }
+  const projectPath = path.resolve(process.cwd(), projectName);
+  const dirExists = await fs.access(projectPath).then(() => true).catch(() => false);
+  if (dirExists) {
+    const response = await prompts({
+      type: "confirm",
+      name: "overwrite",
+      message: `Directory "${projectName}" already exists. Overwrite?`,
+      initial: false
+    });
+    if (!response.overwrite) {
+      console.log(chalk.yellow("Aborted"));
+      process.exit(0);
+    }
+    await fs.rm(projectPath, { recursive: true, force: true });
+  }
+  const answers = await prompts([
+    {
+      type: "select",
+      name: "packageManager",
+      message: "Package manager:",
+      choices: [
+        { title: "pnpm (recommended)", value: "pnpm" },
+        { title: "npm", value: "npm" },
+        { title: "yarn", value: "yarn" }
+      ],
+      initial: 0
+    },
+    {
+      type: "multiselect",
+      name: "features",
+      message: "Select features:",
+      choices: [
+        { title: "Screenshots (web + CLI)", value: "screenshots", selected: true },
+        { title: "Mermaid diagrams", value: "mermaid", selected: true },
+        { title: "Git integration", value: "git", selected: true }
+      ]
+    },
+    {
+      type: (_prev, values) => values.features.includes("git") ? "text" : null,
+      name: "gitRepo",
+      message: "Git repository URL (optional):",
+      initial: ""
+    }
+  ]);
+  const config = {
+    projectName,
+    packageManager: answers.packageManager,
+    features: {
+      screenshots: answers.features.includes("screenshots"),
+      mermaid: answers.features.includes("mermaid"),
+      git: answers.features.includes("git")
+    },
+    gitRepo: answers.gitRepo
+  };
+  const spinner = ora("Creating project...").start();
+  try {
+    await generateProject(projectPath, config);
+    spinner.succeed("Project created successfully!");
+    spinner.text = "Installing dependencies...";
+    spinner.start();
+    await installDependencies(projectPath, config.packageManager);
+    spinner.succeed("Dependencies installed!");
+    console.log(chalk.green.bold("\n\u2728 All done!\n"));
+    console.log(chalk.cyan("Next steps:"));
+    console.log(chalk.gray(`  cd ${projectName}`));
+    console.log(chalk.gray(`  ${config.packageManager} dev`));
+    console.log();
+  } catch (error) {
+    spinner.fail("Failed to create project");
+    console.error(chalk.red(error instanceof Error ? error.message : "Unknown error"));
+    process.exit(1);
+  }
+}
+async function generateProject(projectPath, config) {
+  await fs.mkdir(projectPath, { recursive: true });
+  const packageJson = {
+    name: config.projectName,
+    version: "0.1.0",
+    private: true,
+    type: "module",
+    scripts: {
+      dev: "vite dev",
+      build: "vite build",
+      preview: "vite preview"
+    },
+    dependencies: {
+      "@goobits/docs-engine": "latest",
+      "@sveltejs/kit": "^2.0.0",
+      svelte: "^5.0.0"
+    },
+    devDependencies: {
+      "@sveltejs/adapter-auto": "^3.0.0",
+      "@sveltejs/vite-plugin-svelte": "^4.0.0",
+      vite: "^6.0.0"
+    }
+  };
+  await fs.writeFile(path.join(projectPath, "package.json"), JSON.stringify(packageJson, null, 2));
+  await fs.mkdir(path.join(projectPath, "docs"), { recursive: true });
+  await fs.mkdir(path.join(projectPath, "src/routes"), { recursive: true });
+  await fs.writeFile(
+    path.join(projectPath, "docs/index.md"),
+    `---
+title: Home
+description: Welcome to the documentation
+section: Getting Started
+order: 1
+---
+
+# Welcome to Docs Engine
+
+This is your new documentation site powered by docs-engine.
+
+## Features
+
+- \u{1F4DD} Markdown-based documentation
+- \u{1F3A8} Beautiful theming (Dracula, GitHub, Minimal)
+- \u{1F50D} Instant Cmd+K search
+- \u2B05\uFE0F\u27A1\uFE0F Previous/Next navigation
+- \u{1F527} Git integration with edit links
+- \u{1F4CA} Mermaid diagrams
+${config.features.screenshots ? "- \u{1F4F8} Screenshot support\n" : ""}`
+  );
+  await fs.writeFile(
+    path.join(projectPath, "docs/getting-started.md"),
+    `---
+title: Getting Started
+description: Learn how to use docs-engine
+section: Getting Started
+order: 2
+---
+
+# Getting Started
+
+Start writing documentation by adding markdown files to the \`docs/\` directory.
+
+## Writing Docs
+
+Each markdown file can have frontmatter:
+
+\`\`\`yaml
+---
+title: Page Title
+description: Page description
+section: Section Name
+order: 1
+---
+\`\`\`
+`
+  );
+  await fs.writeFile(
+    path.join(projectPath, "README.md"),
+    `# ${config.projectName}
+
+Documentation site built with [docs-engine](https://github.com/goobits/docs-engine).
+
+## Development
+
+\`\`\`bash
+${config.packageManager} dev
+\`\`\`
+
+## Building
+
+\`\`\`bash
+${config.packageManager} build
+\`\`\`
+`
+  );
+  await fs.writeFile(
+    path.join(projectPath, ".gitignore"),
+    `node_modules/
+.svelte-kit/
+build/
+.DS_Store
+*.log
+`
+  );
+}
+async function installDependencies(projectPath, packageManager) {
+  const commands = {
+    npm: "npm install",
+    pnpm: "pnpm install",
+    yarn: "yarn"
+  };
+  execSync(commands[packageManager], {
+    cwd: projectPath,
+    stdio: "ignore"
+  });
+}
+main().catch((error) => {
+  console.error(chalk.red("Unexpected error:"), error);
+  process.exit(1);
+});

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "create-docs-engine",
+  "version": "2.0.0",
+  "description": "CLI tool to scaffold a new docs-engine documentation site",
+  "type": "module",
+  "bin": {
+    "create-docs-engine": "./dist/index.js"
+  },
+  "main": "./dist/index.js",
+  "files": [
+    "dist",
+    "template"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch"
+  },
+  "keywords": [
+    "documentation",
+    "sveltekit",
+    "markdown",
+    "docs",
+    "cli",
+    "generator"
+  ],
+  "author": "",
+  "license": "MIT",
+  "dependencies": {
+    "prompts": "^2.4.2",
+    "chalk": "^5.6.2",
+    "ora": "^9.1.0"
+  },
+  "devDependencies": {
+    "@types/node": "^25.0.10",
+    "@types/prompts": "^2.4.9",
+    "tsup": "^8.5.1",
+    "typescript": "^5.9.3"
+  }
+}