@heyo-sh/create-heyo-docs 0.1.0 → 0.2.0

package/README.md

@@ -0,0 +1,52 @@
+# Create Heyo Docs
+
+Create a standalone, production-ready documentation site with Heyo Docs. Choose React Router, Next.js, or Astro, plus a built-in theme and deployment target.
+
+## Create a project
+
+```bash
+# pnpm
+pnpm create @heyo-sh/heyo-docs my-docs
+cd my-docs
+pnpm dev
+
+# npm
+npm create @heyo-sh/heyo-docs@latest my-docs
+cd my-docs
+npm run dev
+
+# Yarn
+yarn dlx @heyo-sh/create-heyo-docs my-docs
+cd my-docs
+yarn dev
+
+# Bun
+bun create @heyo-sh/heyo-docs my-docs
+cd my-docs
+bun run dev
+```
+
+The creator works with pnpm, npm, Yarn, and Bun.
+
+## Options
+
+```bash
+pnpm create @heyo-sh/heyo-docs my-docs \
+  --template astro \
+  --theme moss \
+  --deployment cloudflare
+```
+
+| Option              | Values                          |
+| ------------------- | ------------------------------- |
+| `--template`        | `react-router`, `next`, `astro` |
+| `--theme`           | `grain`, `shade`, `moss`        |
+| `--deployment`      | `cloudflare`, `vercel`, `later` |
+| `--package-manager` | `bun`, `pnpm`, `npm`, `yarn`    |
+| `--no-install`      | Skip dependency installation    |
+
+Read the [full documentation](https://docs.heyo.sh) for configuration, content, components, framework integrations, and deployment.
+
+## License
+
+[MIT](https://github.com/heyo-sh/heyo-docs/blob/main/LICENSE)

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-#!/usr/bin/env bun
+#!/usr/bin/env node
 import type { CreateOptions } from "./types";
 export { detectPackageManager, packageManagerField, packageManagerRunCommand, } from "./package-manager";
 export { scaffoldProject } from "./scaffold";

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AASA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAE7C,OAAO,EACL,oBAAoB,EACpB,mBAAmB,EACnB,wBAAwB,GACzB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAC7C,OAAO,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAC;AAChE,mBAAmB,SAAS,CAAC;AA2C7B,wBAAsB,GAAG,CAAC,IAAI,WAAwB,GAAG,OAAO,CAAC,IAAI,CAAC,CAwBrE;AAED,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG;IAC9C,OAAO,EAAE,aAAa,CAAC;IACvB,WAAW,EAAE,OAAO,CAAC;IACrB,QAAQ,EAAE,OAAO,CAAC;CACnB,CAsDA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAYA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAE7C,OAAO,EACL,oBAAoB,EACpB,mBAAmB,EACnB,wBAAwB,GACzB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAC7C,OAAO,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAC;AAChE,mBAAmB,SAAS,CAAC;AAqD7B,wBAAsB,GAAG,CAAC,IAAI,WAAwB,GAAG,OAAO,CAAC,IAAI,CAAC,CAwBrE;AAED,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG;IAC9C,OAAO,EAAE,aAAa,CAAC;IACvB,WAAW,EAAE,OAAO,CAAC;IACrB,QAAQ,EAAE,OAAO,CAAC;CACnB,CAsDA"}

package/dist/index.js

@@ -1,10 +1,12 @@
-#!/usr/bin/env bun
-// @bun
+#!/usr/bin/env node
 
 // src/index.ts
+import { realpathSync } from "node:fs";
+import { fileURLToPath } from "node:url";
 import * as p from "@clack/prompts";
 
 // src/package-manager.ts
+import { spawnSync } from "node:child_process";
 var FALLBACK_VERSIONS = {
   bun: "1.3.1",
   pnpm: "10.17.0",
@@ -14,7 +16,7 @@ var FALLBACK_VERSIONS = {
 function detectPackageManager(userAgent = process.env.npm_config_user_agent ?? "") {
   const match = userAgent.match(/(?:^|\s)(bun|pnpm|npm|yarn)\/([^\s]+)/);
   if (!match)
-    return { name: "bun", version: Bun.version };
+    return { name: "npm" };
   return { name: match[1], version: match[2] };
 }
 function packageManagerField(manager, detected = detectPackageManager()) {
@@ -22,9 +24,11 @@ function packageManagerField(manager, detected = detectPackageManager()) {
     return `${manager}@${detected.version}`;
   const executable = manager === "yarn" ? "yarn" : manager;
   try {
-    const result = Bun.spawnSync([executable, "--version"]);
-    const version = new TextDecoder().decode(result.stdout).trim();
-    if (result.exitCode === 0 && /^\d+(?:\.\d+)+/.test(version))
+    const result = spawnSync(executable, ["--version"], {
+      encoding: "utf8"
+    });
+    const version = result.stdout?.trim();
+    if (result.status === 0 && version && /^\d+(?:\.\d+)+/.test(version))
       return `${manager}@${version}`;
   } catch {}
   return `${manager}@${FALLBACK_VERSIONS[manager]}`;
@@ -56,9 +60,10 @@ function assertProjectName(value) {
 }
 
 // src/scaffold.ts
-import { existsSync } from "fs";
-import { mkdir as mkdir2, readdir as readdir2 } from "fs/promises";
-import { join as join2, resolve } from "path";
+import { spawn } from "node:child_process";
+import { existsSync } from "node:fs";
+import { mkdir as mkdir2, readdir as readdir2 } from "node:fs/promises";
+import { join as join2, resolve } from "node:path";
 
 // src/utils.ts
 import {
@@ -69,8 +74,8 @@ import {
   rm,
   stat,
   writeFile
-} from "fs/promises";
-import { dirname, join } from "path";
+} from "node:fs/promises";
+import { dirname, join } from "node:path";
 function replacePlaceholders(source, values) {
   return source.replace(/\{\{([A-Z0-9_]+)\}\}/g, (placeholder, key) => values[key] ?? placeholder);
 }
@@ -148,13 +153,19 @@ async function copyOverlay(source, destination, placeholders) {
 }
 async function installDependencies(projectPath, packageManager) {
   const command = packageManagerInstallCommand(packageManager);
-  const process2 = Bun.spawn(command, {
-    cwd: projectPath,
-    stdout: "inherit",
-    stderr: "inherit"
+  const [executable, ...arguments_] = command;
+  await new Promise((resolveInstall, rejectInstall) => {
+    const child = spawn(executable, arguments_, {
+      cwd: projectPath,
+      stdio: "inherit"
+    });
+    child.once("error", rejectInstall);
+    child.once("close", (exitCode) => {
+      if (exitCode === 0)
+        return resolveInstall();
+      rejectInstall(new Error(`Dependency installation failed with ${command.join(" ")}.`));
+    });
   });
-  if (await process2.exited !== 0)
-    throw new Error(`Dependency installation failed with ${command.join(" ")}.`);
 }
 
 // src/index.ts
@@ -175,12 +186,12 @@ var THEME_OPTIONS = [
   { value: "moss", label: "Moss" },
   {
     value: "dripper",
-    label: "Dripper \u2014 Soon",
+    label: "Dripper — Soon",
     hint: "Unavailable in this MVP"
   },
   {
     value: "fixed-gear",
-    label: "Fixed Gear \u2014 Soon",
+    label: "Fixed Gear — Soon",
     hint: "Unavailable in this MVP"
   }
 ];
@@ -190,12 +201,22 @@ var PACKAGE_MANAGER_OPTIONS = [
   { value: "npm", label: "npm" },
   { value: "yarn", label: "yarn" }
 ];
-if (import.meta.main) {
+if (isMainModule()) {
   run(process.argv.slice(2)).catch((error) => {
     p.log.error(error instanceof Error ? error.message : String(error));
     process.exitCode = 1;
   });
 }
+function isMainModule() {
+  const entryPoint = process.argv[1];
+  if (!entryPoint)
+    return false;
+  try {
+    return realpathSync(entryPoint) === fileURLToPath(import.meta.url);
+  } catch {
+    return false;
+  }
+}
 async function run(argv = process.argv.slice(2)) {
   const parsed = parseArguments(argv);
   if (parsed.showHelp) {

package/dist/package-manager.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"package-manager.d.ts","sourceRoot":"","sources":["../src/package-manager.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAStE,wBAAgB,oBAAoB,CAClC,SAAS,SAA0C,GAClD,sBAAsB,CAIxB;AAED,wBAAgB,mBAAmB,CACjC,OAAO,EAAE,cAAc,EACvB,QAAQ,yBAAyB,GAChC,MAAM,CAaR;AAED,wBAAgB,4BAA4B,CAC1C,OAAO,EAAE,cAAc,GACtB,MAAM,EAAE,CAEV;AAED,wBAAgB,wBAAwB,CACtC,OAAO,EAAE,cAAc,EACvB,MAAM,EAAE,MAAM,GACb,MAAM,CAIR"}
+{"version":3,"file":"package-manager.d.ts","sourceRoot":"","sources":["../src/package-manager.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,sBAAsB,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAStE,wBAAgB,oBAAoB,CAClC,SAAS,SAA0C,GAClD,sBAAsB,CAIxB;AAED,wBAAgB,mBAAmB,CACjC,OAAO,EAAE,cAAc,EACvB,QAAQ,yBAAyB,GAChC,MAAM,CAeR;AAED,wBAAgB,4BAA4B,CAC1C,OAAO,EAAE,cAAc,GACtB,MAAM,EAAE,CAEV;AAED,wBAAgB,wBAAwB,CACtC,OAAO,EAAE,cAAc,EACvB,MAAM,EAAE,MAAM,GACb,MAAM,CAIR"}

package/dist/scaffold.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"scaffold.d.ts","sourceRoot":"","sources":["../src/scaffold.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAK7C,wBAAsB,eAAe,CACnC,OAAO,EAAE,aAAa,GACrB,OAAO,CAAC;IAAE,WAAW,EAAE,MAAM,CAAA;CAAE,CAAC,CA0ClC"}
+{"version":3,"file":"scaffold.d.ts","sourceRoot":"","sources":["../src/scaffold.ts"],"names":[],"mappings":"AAUA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAK7C,wBAAsB,eAAe,CACnC,OAAO,EAAE,aAAa,GACrB,OAAO,CAAC;IAAE,WAAW,EAAE,MAAM,CAAA;CAAE,CAAC,CA0ClC"}

package/package.json

@@ -1,17 +1,20 @@
 {
   "name": "@heyo-sh/create-heyo-docs",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Create a standalone Heyo Docs documentation project.",
   "homepage": "https://heyo.sh",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/heyo/heyo-docs.git"
+    "url": "git+https://github.com/heyo-sh/heyo-docs.git"
   },
   "bugs": {
-    "url": "https://github.com/heyo/heyo-docs/issues"
+    "url": "https://github.com/heyo-sh/heyo-docs/issues"
   },
   "license": "MIT",
   "type": "module",
+  "engines": {
+    "node": ">=20.11.0"
+  },
   "bin": {
     "create-heyo-docs": "./dist/index.js"
   },
@@ -28,7 +31,7 @@
   },
   "scripts": {
     "dev": "bun run build --watch",
-    "build": "bun build src/index.ts --outdir dist --target bun --external @clack/prompts && bun run build:types",
+    "build": "bun build src/index.ts --outdir dist --target node --external @clack/prompts && bun run build:types",
     "build:types": "tsc -p tsconfig.build.json",
     "typecheck": "tsc -p tsconfig.json",
     "test": "bun test"

package/templates/react-router/content/mdx-components.mdx

@@ -21,7 +21,7 @@ Every component below is available without an import. The examples show every vi
 
 <Button
   align="right"
-  href="https://github.com/heyo/heyo-docs"
+  href="https://github.com/heyo-sh/heyo-docs"
   target="_blank"
   variant="ghost"
   size="xs"
@@ -262,7 +262,7 @@ export function CompactExample() {
 
 <GitHub href="https://github.com/react/react" variant="inset" />
 
-<GitHub href="https://github.com/heyo/heyo-docs" />
+<GitHub href="https://github.com/heyo-sh/heyo-docs" />
 
 ## Steps