docs-ready 0.2.0

package/dist/index.js

@@ -0,0 +1,226 @@
+#!/usr/bin/env node
+import {
+  log,
+  spinner
+} from "./chunk-7YN54Y4Y.js";
+
+// src/cli/index.ts
+import { Command } from "commander";
+import { readFile } from "fs/promises";
+import { fileURLToPath } from "url";
+import path3 from "path";
+
+// src/cli/commands/init.ts
+import fs2 from "fs/promises";
+import path2 from "path";
+import { createInterface } from "readline/promises";
+import { stdin, stdout } from "process";
+
+// src/frameworks/detector.ts
+import fs from "fs/promises";
+import path from "path";
+var DETECTORS = [
+  {
+    name: "docusaurus",
+    files: [
+      "docusaurus.config.ts",
+      "docusaurus.config.js",
+      "docusaurus.config.mts",
+      "docusaurus.config.mjs"
+    ],
+    docsDir: "./docs"
+  },
+  {
+    name: "vitepress",
+    files: [
+      ".vitepress/config.ts",
+      ".vitepress/config.js",
+      ".vitepress/config.mts",
+      ".vitepress/config.mjs"
+    ],
+    docsDir: "./docs"
+  },
+  {
+    name: "mkdocs",
+    files: ["mkdocs.yml", "mkdocs.yaml"],
+    docsDir: "./docs"
+  },
+  {
+    name: "starlight",
+    files: ["astro.config.mjs", "astro.config.ts", "astro.config.js"],
+    docsDir: "./src/content/docs"
+  }
+];
+async function detectFramework(projectDir) {
+  for (const detector of DETECTORS) {
+    for (const file of detector.files) {
+      const fullPath = path.join(projectDir, file);
+      try {
+        await fs.access(fullPath);
+        if (detector.name === "starlight") {
+          const content = await fs.readFile(fullPath, "utf-8");
+          if (!content.includes("starlight")) {
+            continue;
+          }
+        }
+        return {
+          name: detector.name,
+          configFile: fullPath,
+          docsDir: detector.docsDir
+        };
+      } catch {
+      }
+    }
+  }
+  return {
+    name: "generic",
+    configFile: null,
+    docsDir: "./docs"
+  };
+}
+
+// src/cli/commands/init.ts
+async function initCommand(options = {}) {
+  const cwd = options.cwd ?? process.cwd();
+  const configPath = path2.join(cwd, ".docs-ready.yaml");
+  try {
+    await fs2.access(configPath);
+    log.warn(".docs-ready.yaml already exists. Use --force to overwrite.");
+    return;
+  } catch {
+  }
+  const spin = spinner("Detecting project structure...");
+  spin.start();
+  const framework = await detectFramework(cwd);
+  spin.stop();
+  log.info(`Detected framework: ${framework.name}`);
+  log.info(`Docs directory: ${framework.docsDir}`);
+  const platform = await detectPlatform(cwd);
+  if (platform !== "none") {
+    log.info(`Detected platform: ${platform}`);
+  }
+  const hasLlmsPlugin = await detectLlmsPlugin(cwd);
+  if (hasLlmsPlugin) {
+    log.warn("Detected docusaurus-plugin-llms \u2014 disabling llms.txt/llms-full.txt generation.");
+  }
+  const rl = createInterface({ input: stdin, output: stdout });
+  const title = await rl.question("Project title: ");
+  const description = await rl.question("Description: ");
+  const url = await rl.question("Docs URL (e.g. https://docs.example.com): ");
+  rl.close();
+  const templateData = {
+    title: title || "My Project",
+    description: description || "Project documentation",
+    url: url || "https://docs.example.com",
+    docsDir: framework.docsDir,
+    llmsTxt: String(!hasLlmsPlugin),
+    llmsFullTxt: String(!hasLlmsPlugin),
+    platform
+  };
+  const template = await loadTemplate();
+  const rendered = template.replace(/\{\{(\w+)\}\}/g, (_, key) => templateData[key] ?? "");
+  await fs2.writeFile(configPath, rendered, "utf-8");
+  log.success("Created .docs-ready.yaml");
+  log.dim("Next: run `docs-ready generate` to create AI-facing files.");
+}
+async function loadTemplate() {
+  const candidates = [
+    path2.join(path2.dirname(new URL(import.meta.url).pathname), "../../templates/config.yaml.tmpl"),
+    path2.join(path2.dirname(new URL(import.meta.url).pathname), "../templates/config.yaml.tmpl")
+  ];
+  for (const candidate of candidates) {
+    try {
+      return await fs2.readFile(candidate, "utf-8");
+    } catch {
+    }
+  }
+  return `# docs-ready configuration
+title: "{{title}}"
+description: "{{description}}"
+url: "{{url}}"
+docs:
+  dir: "{{docsDir}}"
+  include:
+    - "**/*.md"
+    - "**/*.mdx"
+  exclude:
+    - "**/node_modules/**"
+    - "**/_*"
+generate:
+  llms_txt: {{llmsTxt}}
+  llms_full_txt: {{llmsFullTxt}}
+  ai_context: true
+  output_dir: "./build"
+deploy:
+  platform: "{{platform}}"
+`;
+}
+async function detectPlatform(cwd) {
+  const checks = [
+    { file: "vercel.json", platform: "vercel" },
+    { file: "netlify.toml", platform: "netlify" },
+    { file: "_headers", platform: "cloudflare" },
+    { file: "wrangler.toml", platform: "cloudflare" }
+  ];
+  for (const { file, platform } of checks) {
+    try {
+      await fs2.access(path2.join(cwd, file));
+      return platform;
+    } catch {
+    }
+  }
+  return "none";
+}
+async function detectLlmsPlugin(cwd) {
+  try {
+    const pkgPath = path2.join(cwd, "package.json");
+    const content = await fs2.readFile(pkgPath, "utf-8");
+    const pkg = JSON.parse(content);
+    const allDeps = {
+      ...pkg.dependencies,
+      ...pkg.devDependencies
+    };
+    return "docusaurus-plugin-llms" in allDeps;
+  } catch {
+    return false;
+  }
+}
+
+// src/cli/index.ts
+var __dirname2 = path3.dirname(fileURLToPath(import.meta.url));
+async function getVersion() {
+  let dir = __dirname2;
+  for (let i = 0; i < 5; i++) {
+    try {
+      const pkg = JSON.parse(await readFile(path3.join(dir, "package.json"), "utf-8"));
+      return pkg.version;
+    } catch {
+      dir = path3.dirname(dir);
+    }
+  }
+  return "0.0.0";
+}
+async function main() {
+  const version = await getVersion();
+  const program = new Command();
+  program.name("docs-ready").description("Make your docs AI-ready. Keep them that way.").version(version);
+  program.command("init").description("Initialize docs-ready in your project").action(async () => {
+    await initCommand();
+  });
+  program.command("generate").description("Generate AI-facing documentation files").option("--dry-run", "Show what would be generated without writing files").option("--only <type>", "Generate only: llms-txt or llms-full").action(async (opts) => {
+    const { generateCommand } = await import("./generate-56HFRN5I.js");
+    await generateCommand({ dryRun: opts.dryRun, only: opts.only });
+  });
+  program.command("guard").description("Check AI-facing docs for staleness").action(() => {
+    console.log("Guard command coming in v0.4.0");
+  });
+  program.command("validate").description("Lint and validate AI-facing docs").action(() => {
+    console.log("Validate command coming in v0.6.0");
+  });
+  await program.parseAsync(process.argv);
+}
+main().catch((err) => {
+  console.error(err);
+  process.exit(1);
+});
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/cli/index.ts","../src/cli/commands/init.ts","../src/frameworks/detector.ts"],"sourcesContent":["import { Command } from \"commander\";\nimport { readFile } from \"node:fs/promises\";\nimport { fileURLToPath } from \"node:url\";\nimport path from \"node:path\";\nimport { initCommand } from \"./commands/init.js\";\n\nconst __dirname = path.dirname(fileURLToPath(import.meta.url));\n\nasync function getVersion(): Promise<string> {\n  let dir = __dirname;\n  for (let i = 0; i < 5; i++) {\n    try {\n      const pkg = JSON.parse(await readFile(path.join(dir, \"package.json\"), \"utf-8\"));\n      return pkg.version;\n    } catch {\n      dir = path.dirname(dir);\n    }\n  }\n  return \"0.0.0\";\n}\n\nasync function main(): Promise<void> {\n  const version = await getVersion();\n\n  const program = new Command();\n\n  program\n    .name(\"docs-ready\")\n    .description(\"Make your docs AI-ready. Keep them that way.\")\n    .version(version);\n\n  program\n    .command(\"init\")\n    .description(\"Initialize docs-ready in your project\")\n    .action(async () => {\n      await initCommand();\n    });\n\n  program\n    .command(\"generate\")\n    .description(\"Generate AI-facing documentation files\")\n    .option(\"--dry-run\", \"Show what would be generated without writing files\")\n    .option(\"--only <type>\", \"Generate only: llms-txt or llms-full\")\n    .action(async (opts) => {\n      const { generateCommand } = await import(\"./commands/generate.js\");\n      await generateCommand({ dryRun: opts.dryRun, only: opts.only });\n    });\n\n  program\n    .command(\"guard\")\n    .description(\"Check AI-facing docs for staleness\")\n    .action(() => {\n      console.log(\"Guard command coming in v0.4.0\");\n    });\n\n  program\n    .command(\"validate\")\n    .description(\"Lint and validate AI-facing docs\")\n    .action(() => {\n      console.log(\"Validate command coming in v0.6.0\");\n    });\n\n  await program.parseAsync(process.argv);\n}\n\nmain().catch((err) => {\n  console.error(err);\n  process.exit(1);\n});\n","import fs from \"node:fs/promises\";\nimport path from \"node:path\";\nimport { createInterface } from \"node:readline/promises\";\nimport { stdin, stdout } from \"node:process\";\nimport { detectFramework } from \"../../frameworks/detector.js\";\nimport { log, spinner } from \"../../utils/logger.js\";\n\ninterface InitOptions {\n  cwd?: string;\n}\n\nexport async function initCommand(options: InitOptions = {}): Promise<void> {\n  const cwd = options.cwd ?? process.cwd();\n  const configPath = path.join(cwd, \".docs-ready.yaml\");\n\n  // Check if config already exists\n  try {\n    await fs.access(configPath);\n    log.warn(\".docs-ready.yaml already exists. Use --force to overwrite.\");\n    return;\n  } catch {\n    // Config doesn't exist, proceed\n  }\n\n  const spin = spinner(\"Detecting project structure...\");\n  spin.start();\n\n  // Detect framework\n  const framework = await detectFramework(cwd);\n  spin.stop();\n\n  log.info(`Detected framework: ${framework.name}`);\n  log.info(`Docs directory: ${framework.docsDir}`);\n\n  // Detect deployment platform\n  const platform = await detectPlatform(cwd);\n  if (platform !== \"none\") {\n    log.info(`Detected platform: ${platform}`);\n  }\n\n  // Detect docusaurus-plugin-llms\n  const hasLlmsPlugin = await detectLlmsPlugin(cwd);\n  if (hasLlmsPlugin) {\n    log.warn(\"Detected docusaurus-plugin-llms — disabling llms.txt/llms-full.txt generation.\");\n  }\n\n  // Prompt for project info\n  const rl = createInterface({ input: stdin, output: stdout });\n  const title = await rl.question(\"Project title: \");\n  const description = await rl.question(\"Description: \");\n  const url = await rl.question(\"Docs URL (e.g. https://docs.example.com): \");\n  rl.close();\n\n  // Render config from template (try file first, fall back to inline)\n  const templateData: Record<string, string> = {\n    title: title || \"My Project\",\n    description: description || \"Project documentation\",\n    url: url || \"https://docs.example.com\",\n    docsDir: framework.docsDir,\n    llmsTxt: String(!hasLlmsPlugin),\n    llmsFullTxt: String(!hasLlmsPlugin),\n    platform,\n  };\n\n  const template = await loadTemplate();\n  const rendered = template.replace(/\\{\\{(\\w+)\\}\\}/g, (_, key) => templateData[key] ?? \"\");\n\n  await fs.writeFile(configPath, rendered, \"utf-8\");\n  log.success(\"Created .docs-ready.yaml\");\n  log.dim(\"Next: run `docs-ready generate` to create AI-facing files.\");\n}\n\nasync function loadTemplate(): Promise<string> {\n  // Try to load the template file (works when installed as npm package)\n  const candidates = [\n    path.join(path.dirname(new URL(import.meta.url).pathname), \"../../templates/config.yaml.tmpl\"),\n    path.join(path.dirname(new URL(import.meta.url).pathname), \"../templates/config.yaml.tmpl\"),\n  ];\n\n  for (const candidate of candidates) {\n    try {\n      return await fs.readFile(candidate, \"utf-8\");\n    } catch {\n      // Try next\n    }\n  }\n\n  // Inline fallback\n  return `# docs-ready configuration\ntitle: \"{{title}}\"\ndescription: \"{{description}}\"\nurl: \"{{url}}\"\ndocs:\n  dir: \"{{docsDir}}\"\n  include:\n    - \"**/*.md\"\n    - \"**/*.mdx\"\n  exclude:\n    - \"**/node_modules/**\"\n    - \"**/_*\"\ngenerate:\n  llms_txt: {{llmsTxt}}\n  llms_full_txt: {{llmsFullTxt}}\n  ai_context: true\n  output_dir: \"./build\"\ndeploy:\n  platform: \"{{platform}}\"\n`;\n}\n\nasync function detectPlatform(\n  cwd: string\n): Promise<\"vercel\" | \"netlify\" | \"cloudflare\" | \"none\"> {\n  const checks: Array<{ file: string; platform: \"vercel\" | \"netlify\" | \"cloudflare\" }> = [\n    { file: \"vercel.json\", platform: \"vercel\" },\n    { file: \"netlify.toml\", platform: \"netlify\" },\n    { file: \"_headers\", platform: \"cloudflare\" },\n    { file: \"wrangler.toml\", platform: \"cloudflare\" },\n  ];\n\n  for (const { file, platform } of checks) {\n    try {\n      await fs.access(path.join(cwd, file));\n      return platform;\n    } catch {\n      // Not found, continue\n    }\n  }\n\n  return \"none\";\n}\n\nasync function detectLlmsPlugin(cwd: string): Promise<boolean> {\n  try {\n    const pkgPath = path.join(cwd, \"package.json\");\n    const content = await fs.readFile(pkgPath, \"utf-8\");\n    const pkg = JSON.parse(content);\n    const allDeps = {\n      ...pkg.dependencies,\n      ...pkg.devDependencies,\n    };\n    return \"docusaurus-plugin-llms\" in allDeps;\n  } catch {\n    return false;\n  }\n}\n","import fs from \"node:fs/promises\";\nimport path from \"node:path\";\n\nexport interface FrameworkResult {\n  name: \"docusaurus\" | \"vitepress\" | \"mkdocs\" | \"starlight\" | \"generic\";\n  configFile: string | null;\n  docsDir: string;\n}\n\nconst DETECTORS: Array<{\n  name: FrameworkResult[\"name\"];\n  files: string[];\n  docsDir: string;\n}> = [\n  {\n    name: \"docusaurus\",\n    files: [\n      \"docusaurus.config.ts\",\n      \"docusaurus.config.js\",\n      \"docusaurus.config.mts\",\n      \"docusaurus.config.mjs\",\n    ],\n    docsDir: \"./docs\",\n  },\n  {\n    name: \"vitepress\",\n    files: [\n      \".vitepress/config.ts\",\n      \".vitepress/config.js\",\n      \".vitepress/config.mts\",\n      \".vitepress/config.mjs\",\n    ],\n    docsDir: \"./docs\",\n  },\n  {\n    name: \"mkdocs\",\n    files: [\"mkdocs.yml\", \"mkdocs.yaml\"],\n    docsDir: \"./docs\",\n  },\n  {\n    name: \"starlight\",\n    files: [\"astro.config.mjs\", \"astro.config.ts\", \"astro.config.js\"],\n    docsDir: \"./src/content/docs\",\n  },\n];\n\nexport async function detectFramework(projectDir: string): Promise<FrameworkResult> {\n  for (const detector of DETECTORS) {\n    for (const file of detector.files) {\n      const fullPath = path.join(projectDir, file);\n      try {\n        await fs.access(fullPath);\n\n        if (detector.name === \"starlight\") {\n          const content = await fs.readFile(fullPath, \"utf-8\");\n          if (!content.includes(\"starlight\")) {\n            continue;\n          }\n        }\n\n        return {\n          name: detector.name,\n          configFile: fullPath,\n          docsDir: detector.docsDir,\n        };\n      } catch {\n        // File doesn't exist, try next\n      }\n    }\n  }\n\n  return {\n    name: \"generic\",\n    configFile: null,\n    docsDir: \"./docs\",\n  };\n}\n"],"mappings":";;;;;;;AAAA,SAAS,eAAe;AACxB,SAAS,gBAAgB;AACzB,SAAS,qBAAqB;AAC9B,OAAOA,WAAU;;;ACHjB,OAAOC,SAAQ;AACf,OAAOC,WAAU;AACjB,SAAS,uBAAuB;AAChC,SAAS,OAAO,cAAc;;;ACH9B,OAAO,QAAQ;AACf,OAAO,UAAU;AAQjB,IAAM,YAID;AAAA,EACH;AAAA,IACE,MAAM;AAAA,IACN,OAAO;AAAA,MACL;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACF;AAAA,IACA,SAAS;AAAA,EACX;AAAA,EACA;AAAA,IACE,MAAM;AAAA,IACN,OAAO;AAAA,MACL;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACF;AAAA,IACA,SAAS;AAAA,EACX;AAAA,EACA;AAAA,IACE,MAAM;AAAA,IACN,OAAO,CAAC,cAAc,aAAa;AAAA,IACnC,SAAS;AAAA,EACX;AAAA,EACA;AAAA,IACE,MAAM;AAAA,IACN,OAAO,CAAC,oBAAoB,mBAAmB,iBAAiB;AAAA,IAChE,SAAS;AAAA,EACX;AACF;AAEA,eAAsB,gBAAgB,YAA8C;AAClF,aAAW,YAAY,WAAW;AAChC,eAAW,QAAQ,SAAS,OAAO;AACjC,YAAM,WAAW,KAAK,KAAK,YAAY,IAAI;AAC3C,UAAI;AACF,cAAM,GAAG,OAAO,QAAQ;AAExB,YAAI,SAAS,SAAS,aAAa;AACjC,gBAAM,UAAU,MAAM,GAAG,SAAS,UAAU,OAAO;AACnD,cAAI,CAAC,QAAQ,SAAS,WAAW,GAAG;AAClC;AAAA,UACF;AAAA,QACF;AAEA,eAAO;AAAA,UACL,MAAM,SAAS;AAAA,UACf,YAAY;AAAA,UACZ,SAAS,SAAS;AAAA,QACpB;AAAA,MACF,QAAQ;AAAA,MAER;AAAA,IACF;AAAA,EACF;AAEA,SAAO;AAAA,IACL,MAAM;AAAA,IACN,YAAY;AAAA,IACZ,SAAS;AAAA,EACX;AACF;;;ADjEA,eAAsB,YAAY,UAAuB,CAAC,GAAkB;AAC1E,QAAM,MAAM,QAAQ,OAAO,QAAQ,IAAI;AACvC,QAAM,aAAaC,MAAK,KAAK,KAAK,kBAAkB;AAGpD,MAAI;AACF,UAAMC,IAAG,OAAO,UAAU;AAC1B,QAAI,KAAK,4DAA4D;AACrE;AAAA,EACF,QAAQ;AAAA,EAER;AAEA,QAAM,OAAO,QAAQ,gCAAgC;AACrD,OAAK,MAAM;AAGX,QAAM,YAAY,MAAM,gBAAgB,GAAG;AAC3C,OAAK,KAAK;AAEV,MAAI,KAAK,uBAAuB,UAAU,IAAI,EAAE;AAChD,MAAI,KAAK,mBAAmB,UAAU,OAAO,EAAE;AAG/C,QAAM,WAAW,MAAM,eAAe,GAAG;AACzC,MAAI,aAAa,QAAQ;AACvB,QAAI,KAAK,sBAAsB,QAAQ,EAAE;AAAA,EAC3C;AAGA,QAAM,gBAAgB,MAAM,iBAAiB,GAAG;AAChD,MAAI,eAAe;AACjB,QAAI,KAAK,qFAAgF;AAAA,EAC3F;AAGA,QAAM,KAAK,gBAAgB,EAAE,OAAO,OAAO,QAAQ,OAAO,CAAC;AAC3D,QAAM,QAAQ,MAAM,GAAG,SAAS,iBAAiB;AACjD,QAAM,cAAc,MAAM,GAAG,SAAS,eAAe;AACrD,QAAM,MAAM,MAAM,GAAG,SAAS,4CAA4C;AAC1E,KAAG,MAAM;AAGT,QAAM,eAAuC;AAAA,IAC3C,OAAO,SAAS;AAAA,IAChB,aAAa,eAAe;AAAA,IAC5B,KAAK,OAAO;AAAA,IACZ,SAAS,UAAU;AAAA,IACnB,SAAS,OAAO,CAAC,aAAa;AAAA,IAC9B,aAAa,OAAO,CAAC,aAAa;AAAA,IAClC;AAAA,EACF;AAEA,QAAM,WAAW,MAAM,aAAa;AACpC,QAAM,WAAW,SAAS,QAAQ,kBAAkB,CAAC,GAAG,QAAQ,aAAa,GAAG,KAAK,EAAE;AAEvF,QAAMA,IAAG,UAAU,YAAY,UAAU,OAAO;AAChD,MAAI,QAAQ,0BAA0B;AACtC,MAAI,IAAI,4DAA4D;AACtE;AAEA,eAAe,eAAgC;AAE7C,QAAM,aAAa;AAAA,IACjBD,MAAK,KAAKA,MAAK,QAAQ,IAAI,IAAI,YAAY,GAAG,EAAE,QAAQ,GAAG,kCAAkC;AAAA,IAC7FA,MAAK,KAAKA,MAAK,QAAQ,IAAI,IAAI,YAAY,GAAG,EAAE,QAAQ,GAAG,+BAA+B;AAAA,EAC5F;AAEA,aAAW,aAAa,YAAY;AAClC,QAAI;AACF,aAAO,MAAMC,IAAG,SAAS,WAAW,OAAO;AAAA,IAC7C,QAAQ;AAAA,IAER;AAAA,EACF;AAGA,SAAO;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAoBT;AAEA,eAAe,eACb,KACuD;AACvD,QAAM,SAAiF;AAAA,IACrF,EAAE,MAAM,eAAe,UAAU,SAAS;AAAA,IAC1C,EAAE,MAAM,gBAAgB,UAAU,UAAU;AAAA,IAC5C,EAAE,MAAM,YAAY,UAAU,aAAa;AAAA,IAC3C,EAAE,MAAM,iBAAiB,UAAU,aAAa;AAAA,EAClD;AAEA,aAAW,EAAE,MAAM,SAAS,KAAK,QAAQ;AACvC,QAAI;AACF,YAAMA,IAAG,OAAOD,MAAK,KAAK,KAAK,IAAI,CAAC;AACpC,aAAO;AAAA,IACT,QAAQ;AAAA,IAER;AAAA,EACF;AAEA,SAAO;AACT;AAEA,eAAe,iBAAiB,KAA+B;AAC7D,MAAI;AACF,UAAM,UAAUA,MAAK,KAAK,KAAK,cAAc;AAC7C,UAAM,UAAU,MAAMC,IAAG,SAAS,SAAS,OAAO;AAClD,UAAM,MAAM,KAAK,MAAM,OAAO;AAC9B,UAAM,UAAU;AAAA,MACd,GAAG,IAAI;AAAA,MACP,GAAG,IAAI;AAAA,IACT;AACA,WAAO,4BAA4B;AAAA,EACrC,QAAQ;AACN,WAAO;AAAA,EACT;AACF;;;AD3IA,IAAMC,aAAYC,MAAK,QAAQ,cAAc,YAAY,GAAG,CAAC;AAE7D,eAAe,aAA8B;AAC3C,MAAI,MAAMD;AACV,WAAS,IAAI,GAAG,IAAI,GAAG,KAAK;AAC1B,QAAI;AACF,YAAM,MAAM,KAAK,MAAM,MAAM,SAASC,MAAK,KAAK,KAAK,cAAc,GAAG,OAAO,CAAC;AAC9E,aAAO,IAAI;AAAA,IACb,QAAQ;AACN,YAAMA,MAAK,QAAQ,GAAG;AAAA,IACxB;AAAA,EACF;AACA,SAAO;AACT;AAEA,eAAe,OAAsB;AACnC,QAAM,UAAU,MAAM,WAAW;AAEjC,QAAM,UAAU,IAAI,QAAQ;AAE5B,UACG,KAAK,YAAY,EACjB,YAAY,8CAA8C,EAC1D,QAAQ,OAAO;AAElB,UACG,QAAQ,MAAM,EACd,YAAY,uCAAuC,EACnD,OAAO,YAAY;AAClB,UAAM,YAAY;AAAA,EACpB,CAAC;AAEH,UACG,QAAQ,UAAU,EAClB,YAAY,wCAAwC,EACpD,OAAO,aAAa,oDAAoD,EACxE,OAAO,iBAAiB,sCAAsC,EAC9D,OAAO,OAAO,SAAS;AACtB,UAAM,EAAE,gBAAgB,IAAI,MAAM,OAAO,wBAAwB;AACjE,UAAM,gBAAgB,EAAE,QAAQ,KAAK,QAAQ,MAAM,KAAK,KAAK,CAAC;AAAA,EAChE,CAAC;AAEH,UACG,QAAQ,OAAO,EACf,YAAY,oCAAoC,EAChD,OAAO,MAAM;AACZ,YAAQ,IAAI,gCAAgC;AAAA,EAC9C,CAAC;AAEH,UACG,QAAQ,UAAU,EAClB,YAAY,kCAAkC,EAC9C,OAAO,MAAM;AACZ,YAAQ,IAAI,mCAAmC;AAAA,EACjD,CAAC;AAEH,QAAM,QAAQ,WAAW,QAAQ,IAAI;AACvC;AAEA,KAAK,EAAE,MAAM,CAAC,QAAQ;AACpB,UAAQ,MAAM,GAAG;AACjB,UAAQ,KAAK,CAAC;AAChB,CAAC;","names":["path","fs","path","path","fs","__dirname","path"]}

package/package.json

@@ -0,0 +1,65 @@
+{
+  "name": "docs-ready",
+  "version": "0.2.0",
+  "description": "Make your docs AI-ready. Keep them that way.",
+  "type": "module",
+  "bin": {
+    "docs-ready": "./dist/index.js"
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "dist",
+    "templates"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "typecheck": "tsc --noEmit",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "docs-ready",
+    "llms-txt",
+    "llms.txt",
+    "ai-context",
+    "documentation",
+    "ai-ready",
+    "llm",
+    "docusaurus",
+    "vitepress",
+    "mkdocs"
+  ],
+  "author": "udhaykumarbala",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/udhaykumarbala/docs-ready"
+  },
+  "homepage": "https://github.com/udhaykumarbala/docs-ready",
+  "engines": {
+    "node": ">=18"
+  },
+  "dependencies": {
+    "chalk": "^5.3.0",
+    "commander": "^12.1.0",
+    "glob": "^11.0.0",
+    "gray-matter": "^4.0.3",
+    "ora": "^8.1.0",
+    "yaml": "^2.5.0"
+  },
+  "devDependencies": {
+    "@types/node": "^25.5.2",
+    "tsup": "^8.2.0",
+    "typescript": "^5.5.0",
+    "vitest": "^2.0.0"
+  }
+}

package/templates/config.yaml.tmpl

@@ -0,0 +1,31 @@
+# ============================================================
+# docs-ready configuration
+# Generated by `docs-ready init`
+# Full reference: https://github.com/udhaykumarbala/docs-ready
+# ============================================================
+
+# --- Project metadata ---
+title: "{{title}}"
+description: "{{description}}"
+url: "{{url}}"
+
+# --- Documentation source ---
+docs:
+  dir: "{{docsDir}}"
+  include:
+    - "**/*.md"
+    - "**/*.mdx"
+  exclude:
+    - "**/node_modules/**"
+    - "**/_*"
+
+# --- Generation ---
+generate:
+  llms_txt: {{llmsTxt}}
+  llms_full_txt: {{llmsFullTxt}}
+  ai_context: true
+  output_dir: "./build"
+
+# --- Deployment ---
+deploy:
+  platform: "{{platform}}"