@aravindc26/velu 0.11.12 → 0.11.14

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aravindc26/velu",
-  "version": "0.11.12",
+  "version": "0.11.14",
   "description": "A modern documentation site generator powered by Markdown and JSON configuration",
   "type": "module",
   "license": "MIT",

package/src/build.ts

@@ -137,6 +137,9 @@ interface VeluRedirect {
 
 interface VeluConfig {
   $schema?: string;
+  name?: string;
+  title?: string;
+  description?: string;
   theme?: string;
   variables?: Record<string, string>;
   colors?: VeluColors;
@@ -587,7 +590,7 @@ const STATIC_EXTENSIONS = new Set([
   ".zip",
 ]);
 
-function copyStaticAssets(docsDir: string, publicDir: string) {
+function copyStaticAssets(docsDir: string, publicDir: string) {
   function walk(dir: string) {
     const entries = readdirSync(dir, { withFileTypes: true });
     for (const entry of entries) {
@@ -611,12 +614,35 @@ function copyStaticAssets(docsDir: string, publicDir: string) {
     }
   }
 
-  walk(docsDir);
-}
-
-function toPosixPath(value: string): string {
-  return value.replace(/\\/g, "/");
-}
+  walk(docsDir);
+}
+
+function resolveProjectName(config: VeluConfig): string {
+  const fromName = typeof config.name === "string" ? config.name.trim() : "";
+  if (fromName) return fromName;
+  const fromTitle = typeof config.title === "string" ? config.title.trim() : "";
+  if (fromTitle) return fromTitle;
+  return "Documentation";
+}
+
+function resolveProjectDescription(config: VeluConfig): string {
+  if (typeof config.description === "string") return config.description.trim();
+  return "";
+}
+
+function writeProjectConstFile(config: VeluConfig, outDir: string) {
+  const constPayload = {
+    name: resolveProjectName(config),
+    description: resolveProjectDescription(config),
+  };
+
+  const constPath = join(outDir, "public", "const.json");
+  writeFileSync(constPath, `${JSON.stringify(constPayload, null, 2)}\n`, "utf-8");
+}
+
+function toPosixPath(value: string): string {
+  return value.replace(/\\/g, "/");
+}
 
 function isInsideDocsRoot(docsDir: string, targetPath: string): boolean {
   const relPath = relative(docsDir, targetPath);
@@ -1167,12 +1193,14 @@ function build(docsDir: string, outDir: string) {
   console.log(`📋 Copied ${configName} as ${PRIMARY_CONFIG_NAME} (and legacy ${LEGACY_CONFIG_NAME})`);
 
   // ── 3b. Copy static assets from docs project into public/ ─────────────────
-  copyStaticAssets(docsDir, join(outDir, "public"));
-  writeRedirectArtifacts(config, outDir);
-  if ((config.redirects ?? []).length > 0) {
-    console.log("↪️  Generated redirect artifacts");
-  }
-  console.log("🖼️  Copied static assets");
+  copyStaticAssets(docsDir, join(outDir, "public"));
+  writeRedirectArtifacts(config, outDir);
+  writeProjectConstFile(rawConfig, outDir);
+  if ((config.redirects ?? []).length > 0) {
+    console.log("↪️  Generated redirect artifacts");
+  }
+  console.log("🧾 Generated const.json");
+  console.log("🖼️  Copied static assets");
 
   // ── 4. Build content + metadata artifacts ────────────────────────────────
   const contentDir = join(outDir, "content", "docs");

package/src/cli.ts

@@ -334,6 +334,24 @@ function collectMarkdownPaths(distDir: string): string[] {
   return Array.from(markdownPaths).sort((a, b) => a.localeCompare(b));
 }
 
+function addLlmsTextAliases(distDir: string): number {
+  const mappings: Array<{ source: string; target: string }> = [
+    { source: "llms-file", target: "llms.txt" },
+    { source: "llms-full-file", target: "llms-full.txt" },
+  ];
+
+  let added = 0;
+  for (const { source, target } of mappings) {
+    const sourcePath = join(distDir, source);
+    const targetPath = join(distDir, target);
+    if (!existsSync(sourcePath) || existsSync(targetPath)) continue;
+    copyFileSync(sourcePath, targetPath);
+    added += 1;
+  }
+
+  return added;
+}
+
 function addStaticRouteCompatibility(outDir: string) {
   const distDir = join(outDir, "dist");
   if (!existsSync(distDir)) return;
@@ -419,6 +437,11 @@ function addStaticRouteCompatibility(outDir: string) {
     console.log(`📄 Added inline markdown headers for ${mdPaths.length} .md routes`);
   }
 
+  const llmsAliasesAdded = addLlmsTextAliases(distDir);
+  if (llmsAliasesAdded > 0) {
+    console.log(`🤖 Added ${llmsAliasesAdded} llms text aliases (.txt)`);
+  }
+
   console.log(`🔁 Added static compatibility for ${routes.length} routes (${aliasCount} .html aliases, ${redirectAdded} redirects)`);
 }