@gitpagedocs/cli 1.1.62 → 1.1.64

package/runtime/output.mjs

@@ -1,159 +1,159 @@
-import { existsSync, readdirSync, rmSync } from "node:fs";
-import { mkdir, writeFile } from "node:fs/promises";
-import path from "node:path";
-import {
-  parseDocFileToKey,
-  parseHtmlFileToKey,
-  extractLanguageFromPath,
-  withVersionBadge,
-  normalizeToOutputPath,
-} from "./doc-path-resolver.mjs";
-import { layoutsArtifactPaths } from "../contracts/layouts-paths.mjs";
-
-const DEFAULT_ICON_SVG = `<?xml version="1.0" encoding="utf-8"?>
-<svg width="800px" height="800px" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg">
-<path opacity="0.1" fill-rule="evenodd" clip-rule="evenodd" d="M12 3C4.5885 3 3 4.5885 3 12C3 19.4115 4.5885 21 12 21C19.4115 21 21 19.4115 21 12C21 4.5885 19.4115 3 12 3ZM14.2695 9.03471C15.1872 8.34452 15.7204 8.25293 15.9299 8.25017C16.1326 8.86788 16.1588 9.54654 16.0042 10.1835C15.9945 10.2234 15.9842 10.263 15.9731 10.3025C15.941 10.4168 15.9647 10.5393 16.0366 10.6333L16.0377 10.6347C16.0521 10.6537 16.0664 10.6728 16.0805 10.6922C16.5194 11.2949 16.7603 12.0687 16.7497 12.8714L16.7496 12.8747C16.7496 14.5738 16.3076 15.5644 15.6994 16.1583C15.0859 16.7572 14.2627 16.9938 13.4137 17.0968L13.3898 17.0997L13.3777 17.1014C12.443 17.2601 11.5456 17.2688 10.6078 17.1286L10.604 17.1281L10.5687 17.1233C9.72415 17.0085 8.90483 16.7616 8.29455 16.1566C7.68912 15.5564 7.25036 14.5643 7.25038 12.8747L7.25034 12.8714C7.23972 12.0687 7.48056 11.2949 7.91949 10.6922C7.93482 10.6711 7.9504 10.6503 7.96621 10.6297C8.03648 10.538 8.05962 10.4184 8.02812 10.3068L8.02599 10.2993C8.01523 10.2608 8.00513 10.2222 7.99569 10.1834C7.84087 9.54684 7.86561 8.86863 8.0659 8.25016C8.27679 8.2528 8.81228 8.34432 9.73045 9.03473C9.76619 9.0616 9.80249 9.08937 9.83937 9.11807C9.93139 9.19 10.0529 9.21205 10.1644 9.17703L10.1657 9.17661C10.2268 9.15768 10.2882 9.13972 10.3496 9.12272C11.4349 8.82255 12.5651 8.82255 13.6504 9.12272C13.7088 9.13888 13.7671 9.15592 13.8253 9.17382L13.8277 9.17457C13.9431 9.21015 14.0704 9.18836 14.1678 9.11252C14.2022 9.08578 14.2361 9.05985 14.2695 9.03471Z" fill="#323232"/>
-<path d="M13.717 8.88177C12.5881 8.56954 11.4119 8.56954 10.283 8.88177C10.2637 8.8871 10.2444 8.89254 10.2252 8.89808C10.1067 8.93218 9.97923 8.909 9.8807 8.83491V8.83491C8.69311 7.94193 8.07278 7.98181 7.91927 8.01161V8.01161C7.8946 8.0164 7.87585 8.03481 7.86732 8.05844C7.86516 8.06441 7.86303 8.07038 7.8609 8.07636C7.61639 8.76505 7.57904 9.52813 7.75277 10.2425C7.76289 10.2841 7.77371 10.3255 7.78525 10.3667C7.78601 10.3694 7.78677 10.3721 7.78753 10.3748C7.79754 10.4102 7.7902 10.4483 7.7678 10.4776V10.4776C7.75074 10.4998 7.73394 10.5223 7.71741 10.545C7.24479 11.1939 6.98907 12.0213 7.00036 12.8747C7.00036 16.3399 8.80396 17.1358 10.535 17.3711L10.5708 17.3758C11.5347 17.5199 12.4587 17.511 13.4195 17.3479L13.4438 17.345C15.1832 17.1339 16.9996 16.3587 16.9996 12.8747C17.0109 12.0213 16.7552 11.1939 16.2826 10.545C16.2674 10.5242 16.252 10.5035 16.2364 10.483C16.236 10.4825 16.2356 10.482 16.2352 10.4815C16.211 10.4498 16.203 10.4085 16.2138 10.3701V10.3701C16.2257 10.3277 16.2368 10.2852 16.2471 10.2425C16.421 9.52611 16.3815 8.76076 16.1329 8.07176C16.1313 8.06753 16.1298 8.06331 16.1283 8.05909C16.1195 8.03503 16.1004 8.01628 16.0752 8.01142V8.01142C15.921 7.98164 15.3041 7.94381 14.1193 8.83491V8.83491C14.0208 8.90896 13.8933 8.93197 13.7748 8.89804C13.7556 8.89252 13.7363 8.8871 13.717 8.88177Z" stroke="#323232" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"/>
-<path d="M3 12C3 4.5885 4.5885 3 12 3C19.4115 3 21 4.5885 21 12C21 19.4115 19.4115 21 12 21C4.5885 21 3 19.4115 3 12Z" stroke="#323232" stroke-width="2"/>
-</svg>
-`;
-
-function listExistingVersionIds(root, outputDir) {
-  const versionsRoot = path.join(root, outputDir, "docs", "versions");
-  if (!existsSync(versionsRoot)) return [];
-  return readdirSync(versionsRoot, { withFileTypes: true })
-    .filter((entry) => entry.isDirectory())
-    .map((entry) => entry.name);
-}
-
-function removeLegacySourceViewerFiles(root, outputDir) {
-  const versionIds = listExistingVersionIds(root, outputDir);
-  for (const versionId of versionIds) {
-    for (const language of ["pt", "en", "es"]) {
-      for (const fileName of ["source-viewer", "source-viewer.html"]) {
-        const legacyPath = path.join(root, outputDir, "docs", "versions", versionId, language, fileName);
-        if (existsSync(legacyPath)) {
-          rmSync(legacyPath, { force: true });
-        }
-      }
-    }
-  }
-}
-
-async function writeJson(root, relativePath, data) {
-  const absolutePath = path.join(root, relativePath);
-  await mkdir(path.dirname(absolutePath), { recursive: true });
-  await writeFile(absolutePath, `${JSON.stringify(data, null, 2)}\n`, "utf-8");
-}
-
-export async function writeText(root, relativePath, data) {
-  const absolutePath = path.join(root, relativePath);
-  await mkdir(path.dirname(absolutePath), { recursive: true });
-  await writeFile(absolutePath, data, "utf-8");
-}
-
-/**
- * Write the local layout artifacts into the standalone layouts home.
- *
- * No layouts folder is ever deleted here. The legacy `<outputDir>/layouts/`
- * folder can hold hand-edited templates and the viewer still reads it, so
- * relocating it is an explicit, confirmed migration rather than a side effect of
- * generating. Switching back to official layouts likewise leaves an existing
- * layouts home in place: `layoutsConfigPathOficial` already decides which source
- * the viewer uses, so the files are inert rather than harmful.
- */
-async function writeLayoutArtifacts(options) {
-  const { root, layoutsDir, useLocalLayoutConfig, layouts, artifacts, createThemeTemplate } = options;
-
-  if (!useLocalLayoutConfig) return;
-
-  const paths = layoutsArtifactPaths(layoutsDir);
-  await writeJson(root, paths.config, artifacts.layoutsConfig);
-  await writeJson(root, paths.fallbackConfig, artifacts.fallbackLayoutsConfig);
-  for (const layout of layouts) {
-    await writeJson(root, `${paths.root}/${layout.file}`, createThemeTemplate(layout));
-  }
-}
-
-export async function writeConfigOnlyOutput(options) {
-  const {
-    root,
-    pkgRoot,
-    outputDir,
-    artifacts,
-    useLocalLayoutConfig,
-    layoutsDir,
-    layouts,
-    createThemeTemplate,
-  } = options;
-
-  // Keep only versioned docs output in docs/, removing legacy root language folders.
-  for (const legacyLanguageDir of ["en", "pt", "es"]) {
-    const legacyPath = path.join(root, outputDir, "docs", legacyLanguageDir);
-    if (existsSync(legacyPath)) {
-      rmSync(legacyPath, { recursive: true, force: true });
-    }
-  }
-
-  await writeJson(root, `${outputDir}/config.json`, artifacts.rootConfig);
-  await writeText(root, `${outputDir}/icon.svg`, DEFAULT_ICON_SVG);
-  await writeLayoutArtifacts({
-    root,
-    layoutsDir,
-    useLocalLayoutConfig,
-    layouts,
-    artifacts,
-    createThemeTemplate,
-  });
-
-  for (const [versionId, versionConfig] of Object.entries(artifacts.versionConfigs)) {
-    await writeJson(root, `${outputDir}/docs/versions/${versionId}/config.json`, versionConfig);
-  }
-
-  removeLegacySourceViewerFiles(root, outputDir);
-
-  for (const [versionId, versionConfig] of Object.entries(artifacts.versionConfigs)) {
-    const versionRoutesMd = versionConfig["routes-md"] ?? versionConfig.routes ?? [];
-    for (const route of versionRoutesMd) {
-      for (const docPath of Object.values(route.path ?? {})) {
-        const fileName = path.basename(docPath);
-        const key = parseDocFileToKey(fileName);
-        const language = extractLanguageFromPath(docPath);
-        const content = key && language ? artifacts.docs?.[language]?.[key] : undefined;
-        if (!content) continue;
-        const versionedContent = withVersionBadge(content, versionId, language);
-        await writeText(root, normalizeToOutputPath(outputDir, docPath), versionedContent);
-      }
-    }
-
-    const versionRoutesHtml = versionConfig["routes-html"] ?? [];
-    const docsHtml = artifacts.docsHtml ?? {};
-    for (const route of versionRoutesHtml) {
-      if (route.url) continue;
-      for (const docPath of Object.values(route.path ?? {})) {
-        const fileName = path.basename(docPath);
-        const key = parseHtmlFileToKey(fileName);
-        const language = extractLanguageFromPath(docPath);
-        const content = key && language ? docsHtml[key]?.[language] : undefined;
-        if (!content) continue;
-        const normalizedHtmlPath = normalizeToOutputPath(outputDir, docPath);
-        await writeText(root, normalizedHtmlPath, content);
-        // Backward-compatible alias for tools or users that still expect ".html".
-        if (!path.extname(docPath)) {
-          await writeText(root, `${normalizedHtmlPath}.html`, content);
-        }
-      }
-    }
-
-    // Ensure version folders always include an index file.
-    for (const language of ["pt", "en", "es"]) {
-      const fallbackIndex = artifacts.docs?.[language]?.index;
-      if (!fallbackIndex) continue;
-      const versionIndexPath = `${outputDir}/docs/versions/${versionId}/${language}/index.md`;
-      if (!existsSync(path.join(root, versionIndexPath))) {
-        const versionedFallbackIndex = withVersionBadge(fallbackIndex, versionId, language);
-        await writeText(root, versionIndexPath, versionedFallbackIndex);
-      }
-    }
-  }
-}
+import { existsSync, readdirSync, rmSync } from "node:fs";
+import { mkdir, writeFile } from "node:fs/promises";
+import path from "node:path";
+import {
+  parseDocFileToKey,
+  parseHtmlFileToKey,
+  extractLanguageFromPath,
+  withVersionBadge,
+  normalizeToOutputPath,
+} from "./doc-path-resolver.mjs";
+import { layoutsArtifactPaths } from "../contracts/layouts-paths.mjs";
+
+const DEFAULT_ICON_SVG = `<?xml version="1.0" encoding="utf-8"?>
+<svg width="800px" height="800px" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg">
+<path opacity="0.1" fill-rule="evenodd" clip-rule="evenodd" d="M12 3C4.5885 3 3 4.5885 3 12C3 19.4115 4.5885 21 12 21C19.4115 21 21 19.4115 21 12C21 4.5885 19.4115 3 12 3ZM14.2695 9.03471C15.1872 8.34452 15.7204 8.25293 15.9299 8.25017C16.1326 8.86788 16.1588 9.54654 16.0042 10.1835C15.9945 10.2234 15.9842 10.263 15.9731 10.3025C15.941 10.4168 15.9647 10.5393 16.0366 10.6333L16.0377 10.6347C16.0521 10.6537 16.0664 10.6728 16.0805 10.6922C16.5194 11.2949 16.7603 12.0687 16.7497 12.8714L16.7496 12.8747C16.7496 14.5738 16.3076 15.5644 15.6994 16.1583C15.0859 16.7572 14.2627 16.9938 13.4137 17.0968L13.3898 17.0997L13.3777 17.1014C12.443 17.2601 11.5456 17.2688 10.6078 17.1286L10.604 17.1281L10.5687 17.1233C9.72415 17.0085 8.90483 16.7616 8.29455 16.1566C7.68912 15.5564 7.25036 14.5643 7.25038 12.8747L7.25034 12.8714C7.23972 12.0687 7.48056 11.2949 7.91949 10.6922C7.93482 10.6711 7.9504 10.6503 7.96621 10.6297C8.03648 10.538 8.05962 10.4184 8.02812 10.3068L8.02599 10.2993C8.01523 10.2608 8.00513 10.2222 7.99569 10.1834C7.84087 9.54684 7.86561 8.86863 8.0659 8.25016C8.27679 8.2528 8.81228 8.34432 9.73045 9.03473C9.76619 9.0616 9.80249 9.08937 9.83937 9.11807C9.93139 9.19 10.0529 9.21205 10.1644 9.17703L10.1657 9.17661C10.2268 9.15768 10.2882 9.13972 10.3496 9.12272C11.4349 8.82255 12.5651 8.82255 13.6504 9.12272C13.7088 9.13888 13.7671 9.15592 13.8253 9.17382L13.8277 9.17457C13.9431 9.21015 14.0704 9.18836 14.1678 9.11252C14.2022 9.08578 14.2361 9.05985 14.2695 9.03471Z" fill="#323232"/>
+<path d="M13.717 8.88177C12.5881 8.56954 11.4119 8.56954 10.283 8.88177C10.2637 8.8871 10.2444 8.89254 10.2252 8.89808C10.1067 8.93218 9.97923 8.909 9.8807 8.83491V8.83491C8.69311 7.94193 8.07278 7.98181 7.91927 8.01161V8.01161C7.8946 8.0164 7.87585 8.03481 7.86732 8.05844C7.86516 8.06441 7.86303 8.07038 7.8609 8.07636C7.61639 8.76505 7.57904 9.52813 7.75277 10.2425C7.76289 10.2841 7.77371 10.3255 7.78525 10.3667C7.78601 10.3694 7.78677 10.3721 7.78753 10.3748C7.79754 10.4102 7.7902 10.4483 7.7678 10.4776V10.4776C7.75074 10.4998 7.73394 10.5223 7.71741 10.545C7.24479 11.1939 6.98907 12.0213 7.00036 12.8747C7.00036 16.3399 8.80396 17.1358 10.535 17.3711L10.5708 17.3758C11.5347 17.5199 12.4587 17.511 13.4195 17.3479L13.4438 17.345C15.1832 17.1339 16.9996 16.3587 16.9996 12.8747C17.0109 12.0213 16.7552 11.1939 16.2826 10.545C16.2674 10.5242 16.252 10.5035 16.2364 10.483C16.236 10.4825 16.2356 10.482 16.2352 10.4815C16.211 10.4498 16.203 10.4085 16.2138 10.3701V10.3701C16.2257 10.3277 16.2368 10.2852 16.2471 10.2425C16.421 9.52611 16.3815 8.76076 16.1329 8.07176C16.1313 8.06753 16.1298 8.06331 16.1283 8.05909C16.1195 8.03503 16.1004 8.01628 16.0752 8.01142V8.01142C15.921 7.98164 15.3041 7.94381 14.1193 8.83491V8.83491C14.0208 8.90896 13.8933 8.93197 13.7748 8.89804C13.7556 8.89252 13.7363 8.8871 13.717 8.88177Z" stroke="#323232" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"/>
+<path d="M3 12C3 4.5885 4.5885 3 12 3C19.4115 3 21 4.5885 21 12C21 19.4115 19.4115 21 12 21C4.5885 21 3 19.4115 3 12Z" stroke="#323232" stroke-width="2"/>
+</svg>
+`;
+
+function listExistingVersionIds(root, outputDir) {
+  const versionsRoot = path.join(root, outputDir, "docs", "versions");
+  if (!existsSync(versionsRoot)) return [];
+  return readdirSync(versionsRoot, { withFileTypes: true })
+    .filter((entry) => entry.isDirectory())
+    .map((entry) => entry.name);
+}
+
+function removeLegacySourceViewerFiles(root, outputDir) {
+  const versionIds = listExistingVersionIds(root, outputDir);
+  for (const versionId of versionIds) {
+    for (const language of ["pt", "en", "es"]) {
+      for (const fileName of ["source-viewer", "source-viewer.html"]) {
+        const legacyPath = path.join(root, outputDir, "docs", "versions", versionId, language, fileName);
+        if (existsSync(legacyPath)) {
+          rmSync(legacyPath, { force: true });
+        }
+      }
+    }
+  }
+}
+
+async function writeJson(root, relativePath, data) {
+  const absolutePath = path.join(root, relativePath);
+  await mkdir(path.dirname(absolutePath), { recursive: true });
+  await writeFile(absolutePath, `${JSON.stringify(data, null, 2)}\n`, "utf-8");
+}
+
+export async function writeText(root, relativePath, data) {
+  const absolutePath = path.join(root, relativePath);
+  await mkdir(path.dirname(absolutePath), { recursive: true });
+  await writeFile(absolutePath, data, "utf-8");
+}
+
+/**
+ * Write the local layout artifacts into the standalone layouts home.
+ *
+ * No layouts folder is ever deleted here. The legacy `<outputDir>/layouts/`
+ * folder can hold hand-edited templates and the viewer still reads it, so
+ * relocating it is an explicit, confirmed migration rather than a side effect of
+ * generating. Switching back to official layouts likewise leaves an existing
+ * layouts home in place: `layoutsConfigPathOficial` already decides which source
+ * the viewer uses, so the files are inert rather than harmful.
+ */
+async function writeLayoutArtifacts(options) {
+  const { root, layoutsDir, useLocalLayoutConfig, layouts, artifacts, createThemeTemplate } = options;
+
+  if (!useLocalLayoutConfig) return;
+
+  const paths = layoutsArtifactPaths(layoutsDir);
+  await writeJson(root, paths.config, artifacts.layoutsConfig);
+  await writeJson(root, paths.fallbackConfig, artifacts.fallbackLayoutsConfig);
+  for (const layout of layouts) {
+    await writeJson(root, `${paths.root}/${layout.file}`, createThemeTemplate(layout));
+  }
+}
+
+export async function writeConfigOnlyOutput(options) {
+  const {
+    root,
+    pkgRoot,
+    outputDir,
+    artifacts,
+    useLocalLayoutConfig,
+    layoutsDir,
+    layouts,
+    createThemeTemplate,
+  } = options;
+
+  // Keep only versioned docs output in docs/, removing legacy root language folders.
+  for (const legacyLanguageDir of ["en", "pt", "es"]) {
+    const legacyPath = path.join(root, outputDir, "docs", legacyLanguageDir);
+    if (existsSync(legacyPath)) {
+      rmSync(legacyPath, { recursive: true, force: true });
+    }
+  }
+
+  await writeJson(root, `${outputDir}/config.json`, artifacts.rootConfig);
+  await writeText(root, `${outputDir}/icon.svg`, DEFAULT_ICON_SVG);
+  await writeLayoutArtifacts({
+    root,
+    layoutsDir,
+    useLocalLayoutConfig,
+    layouts,
+    artifacts,
+    createThemeTemplate,
+  });
+
+  for (const [versionId, versionConfig] of Object.entries(artifacts.versionConfigs)) {
+    await writeJson(root, `${outputDir}/docs/versions/${versionId}/config.json`, versionConfig);
+  }
+
+  removeLegacySourceViewerFiles(root, outputDir);
+
+  for (const [versionId, versionConfig] of Object.entries(artifacts.versionConfigs)) {
+    const versionRoutesMd = versionConfig["routes-md"] ?? versionConfig.routes ?? [];
+    for (const route of versionRoutesMd) {
+      for (const docPath of Object.values(route.path ?? {})) {
+        const fileName = path.basename(docPath);
+        const key = parseDocFileToKey(fileName);
+        const language = extractLanguageFromPath(docPath);
+        const content = key && language ? artifacts.docs?.[language]?.[key] : undefined;
+        if (!content) continue;
+        const versionedContent = withVersionBadge(content, versionId, language);
+        await writeText(root, normalizeToOutputPath(outputDir, docPath), versionedContent);
+      }
+    }
+
+    const versionRoutesHtml = versionConfig["routes-html"] ?? [];
+    const docsHtml = artifacts.docsHtml ?? {};
+    for (const route of versionRoutesHtml) {
+      if (route.url) continue;
+      for (const docPath of Object.values(route.path ?? {})) {
+        const fileName = path.basename(docPath);
+        const key = parseHtmlFileToKey(fileName);
+        const language = extractLanguageFromPath(docPath);
+        const content = key && language ? docsHtml[key]?.[language] : undefined;
+        if (!content) continue;
+        const normalizedHtmlPath = normalizeToOutputPath(outputDir, docPath);
+        await writeText(root, normalizedHtmlPath, content);
+        // Backward-compatible alias for tools or users that still expect ".html".
+        if (!path.extname(docPath)) {
+          await writeText(root, `${normalizedHtmlPath}.html`, content);
+        }
+      }
+    }
+
+    // Ensure version folders always include an index file.
+    for (const language of ["pt", "en", "es"]) {
+      const fallbackIndex = artifacts.docs?.[language]?.index;
+      if (!fallbackIndex) continue;
+      const versionIndexPath = `${outputDir}/docs/versions/${versionId}/${language}/index.md`;
+      if (!existsSync(path.join(root, versionIndexPath))) {
+        const versionedFallbackIndex = withVersionBadge(fallbackIndex, versionId, language);
+        await writeText(root, versionIndexPath, versionedFallbackIndex);
+      }
+    }
+  }
+}

package/runtime/workflow.mjs

@@ -1,129 +1,129 @@
-function sanitizeDocsPath(docsPath) {
-  if (!docsPath || typeof docsPath !== "string") return "";
-  const segment = docsPath.replace(/^\/+|\/+$/g, "").trim();
-  return /^[A-Za-z0-9._-]+$/.test(segment) ? segment : "";
-}
-
-export async function ensureGitHubPagesWorkflow(getCurrentGitBranch, writeText, docsPath = "") {
-  const pathSegment = sanitizeDocsPath(docsPath);
-  const buildStepsBlock =
-    pathSegment
-      ? `      - name: Build static site with target repository path
-        run: pnpm exec next build frontend && mv frontend/out out
-        working-directory: .gitpagedocs-runtime
-        env:
-          GITPAGEDOCS_PATH: "${pathSegment}"
-
-      - name: Relocate output to custom docs path
-        run: |
-          mkdir -p .gitpagedocs-runtime/out_new/${pathSegment}
-          mv .gitpagedocs-runtime/out/* .gitpagedocs-runtime/out_new/${pathSegment}/
-          rm -rf .gitpagedocs-runtime/out
-          mv .gitpagedocs-runtime/out_new .gitpagedocs-runtime/out
-
-      - name: Redirect site root to custom docs path
-        run: printf '%s' '<!doctype html><meta http-equiv="refresh" content="0; url=./${pathSegment}/"><title>Redirecting</title><a href="./${pathSegment}/">Documentation</a>' > .gitpagedocs-runtime/out/index.html`
-      : `      - name: Build static site with target repository path
-        run: pnpm exec next build frontend && mv frontend/out out
-        working-directory: .gitpagedocs-runtime`;
-  const currentBranch = getCurrentGitBranch();
-  const workflowPath = ".github/workflows/gitpagedocs-pages.yml";
-  const workflowContent = `name: Deploy GitPageDocs
-
-on:
-  push:
-    branches: ["${currentBranch}"]
-  workflow_dispatch:
-
-permissions:
-  contents: read
-  pages: write
-  id-token: write
-
-concurrency:
-  group: "pages"
-  cancel-in-progress: false
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    permissions:
-      contents: read
-      pages: write
-      id-token: write
-    env:
-      GITHUB_ACTIONS: "true"
-      GITHUB_REPOSITORY: \${{ github.repository }}
-      GITPAGEDOCS_REPOSITORY_SEARCH: "true"
-    steps:
-      - name: Checkout target repository
-        uses: actions/checkout@v4
-
-      - name: Setup pnpm
-        uses: pnpm/action-setup@v4
-
-      - name: Setup Node
-        uses: actions/setup-node@v4
-        with:
-          node-version: "24"
-
-      - name: Setup Pages
-        uses: actions/configure-pages@v5
-        with:
-          enablement: true
-
-      - name: Prepare runtime source
-        run: |
-          git clone --depth 1 https://github.com/Vidigal-code/git-page-docs.git .gitpagedocs-runtime
-          cp .gitpagedocs-runtime/gitpagedocs/icon.svg /tmp/default-icon.svg 2>/dev/null || true
-          if [ -d gitpagelayouts ]; then
-            rm -rf .gitpagedocs-runtime/gitpagelayouts
-            cp -R gitpagelayouts .gitpagedocs-runtime/gitpagelayouts
-          fi
-          if [ -d gitpagedocs ]; then
-            rm -rf .gitpagedocs-runtime/gitpagedocs
-            cp -R gitpagedocs .gitpagedocs-runtime/gitpagedocs
-          fi
-          mkdir -p .gitpagedocs-runtime/public
-          if [ -f icon.svg ]; then
-            cp icon.svg .gitpagedocs-runtime/public/icon.svg
-          elif [ -f gitpagedocs/icon.svg ]; then
-            cp gitpagedocs/icon.svg .gitpagedocs-runtime/public/icon.svg
-          elif [ -f /tmp/default-icon.svg ]; then
-            cp /tmp/default-icon.svg .gitpagedocs-runtime/public/icon.svg
-          fi
-
-      - name: Install runtime dependencies
-        run: pnpm install --frozen-lockfile
-        working-directory: .gitpagedocs-runtime
-
-${buildStepsBlock}
-
-      - name: Add .nojekyll
-        run: touch .gitpagedocs-runtime/out/.nojekyll 2>/dev/null || mkdir -p .gitpagedocs-runtime/out && touch .gitpagedocs-runtime/out/.nojekyll
-
-      - name: Upload artifact
-        uses: actions/upload-pages-artifact@v3
-        with:
-          path: ./.gitpagedocs-runtime/out
-
-  deploy:
-    environment:
-      name: github-pages
-      url: \${{ steps.deployment.outputs.page_url }}
-    runs-on: ubuntu-latest
-    needs: build
-    permissions:
-      pages: write
-      id-token: write
-    steps:
-      - name: Deploy to GitHub Pages
-        id: deployment
-        uses: actions/deploy-pages@v4
-        with:
-          timeout: 900000
-          error_count: 30
-          reporting_interval: 10000
-`;
-  await writeText(workflowPath, workflowContent);
-}
+function sanitizeDocsPath(docsPath) {
+  if (!docsPath || typeof docsPath !== "string") return "";
+  const segment = docsPath.replace(/^\/+|\/+$/g, "").trim();
+  return /^[A-Za-z0-9._-]+$/.test(segment) ? segment : "";
+}
+
+export async function ensureGitHubPagesWorkflow(getCurrentGitBranch, writeText, docsPath = "") {
+  const pathSegment = sanitizeDocsPath(docsPath);
+  const buildStepsBlock =
+    pathSegment
+      ? `      - name: Build static site with target repository path
+        run: pnpm exec next build frontend && mv frontend/out out
+        working-directory: .gitpagedocs-runtime
+        env:
+          GITPAGEDOCS_PATH: "${pathSegment}"
+
+      - name: Relocate output to custom docs path
+        run: |
+          mkdir -p .gitpagedocs-runtime/out_new/${pathSegment}
+          mv .gitpagedocs-runtime/out/* .gitpagedocs-runtime/out_new/${pathSegment}/
+          rm -rf .gitpagedocs-runtime/out
+          mv .gitpagedocs-runtime/out_new .gitpagedocs-runtime/out
+
+      - name: Redirect site root to custom docs path
+        run: printf '%s' '<!doctype html><meta http-equiv="refresh" content="0; url=./${pathSegment}/"><title>Redirecting</title><a href="./${pathSegment}/">Documentation</a>' > .gitpagedocs-runtime/out/index.html`
+      : `      - name: Build static site with target repository path
+        run: pnpm exec next build frontend && mv frontend/out out
+        working-directory: .gitpagedocs-runtime`;
+  const currentBranch = getCurrentGitBranch();
+  const workflowPath = ".github/workflows/gitpagedocs-pages.yml";
+  const workflowContent = `name: Deploy GitPageDocs
+
+on:
+  push:
+    branches: ["${currentBranch}"]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      pages: write
+      id-token: write
+    env:
+      GITHUB_ACTIONS: "true"
+      GITHUB_REPOSITORY: \${{ github.repository }}
+      GITPAGEDOCS_REPOSITORY_SEARCH: "true"
+    steps:
+      - name: Checkout target repository
+        uses: actions/checkout@v4
+
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v4
+
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: "24"
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+        with:
+          enablement: true
+
+      - name: Prepare runtime source
+        run: |
+          git clone --depth 1 https://github.com/Vidigal-code/git-page-docs.git .gitpagedocs-runtime
+          cp .gitpagedocs-runtime/gitpagedocs/icon.svg /tmp/default-icon.svg 2>/dev/null || true
+          if [ -d gitpagelayouts ]; then
+            rm -rf .gitpagedocs-runtime/gitpagelayouts
+            cp -R gitpagelayouts .gitpagedocs-runtime/gitpagelayouts
+          fi
+          if [ -d gitpagedocs ]; then
+            rm -rf .gitpagedocs-runtime/gitpagedocs
+            cp -R gitpagedocs .gitpagedocs-runtime/gitpagedocs
+          fi
+          mkdir -p .gitpagedocs-runtime/public
+          if [ -f icon.svg ]; then
+            cp icon.svg .gitpagedocs-runtime/public/icon.svg
+          elif [ -f gitpagedocs/icon.svg ]; then
+            cp gitpagedocs/icon.svg .gitpagedocs-runtime/public/icon.svg
+          elif [ -f /tmp/default-icon.svg ]; then
+            cp /tmp/default-icon.svg .gitpagedocs-runtime/public/icon.svg
+          fi
+
+      - name: Install runtime dependencies
+        run: pnpm install --frozen-lockfile
+        working-directory: .gitpagedocs-runtime
+
+${buildStepsBlock}
+
+      - name: Add .nojekyll
+        run: touch .gitpagedocs-runtime/out/.nojekyll 2>/dev/null || mkdir -p .gitpagedocs-runtime/out && touch .gitpagedocs-runtime/out/.nojekyll
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ./.gitpagedocs-runtime/out
+
+  deploy:
+    environment:
+      name: github-pages
+      url: \${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    permissions:
+      pages: write
+      id-token: write
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4
+        with:
+          timeout: 900000
+          error_count: 30
+          reporting_interval: 10000
+`;
+  await writeText(workflowPath, workflowContent);
+}

package/start.mjs

@@ -1,12 +1,12 @@
-#!/usr/bin/env node
-import { spawn } from "child_process";
-
-const env = { ...process.env, GITPAGEDOCS_REPOSITORY_SEARCH: "true" };
-// The Next app lives in frontend/, so `next build` emits to frontend/.next —
-// point `next start` at the same directory (matches `next build frontend`).
-const child = spawn("npx", ["next", "start", "frontend"], {
-  stdio: "inherit",
-  env,
-  shell: true,
-});
-child.on("exit", (code) => process.exit(code ?? 0));
+#!/usr/bin/env node
+import { spawn } from "child_process";
+
+const env = { ...process.env, GITPAGEDOCS_REPOSITORY_SEARCH: "true" };
+// The Next app lives in frontend/, so `next build` emits to frontend/.next —
+// point `next start` at the same directory (matches `next build frontend`).
+const child = spawn("npx", ["next", "start", "frontend"], {
+  stdio: "inherit",
+  env,
+  shell: true,
+});
+child.on("exit", (code) => process.exit(code ?? 0));

package/ui/logger.mjs

@@ -1,9 +1,9 @@
-/** Consistent log formatting */
-
-export function logSuccess(msg) {
-  console.log(`  [ok] ${msg}`);
-}
-
-export function logInfo(msg) {
-  console.log(`  ${msg}`);
-}
+/** Consistent log formatting */
+
+export function logSuccess(msg) {
+  console.log(`  [ok] ${msg}`);
+}
+
+export function logInfo(msg) {
+  console.log(`  ${msg}`);
+}