@gitpagedocs/cli 0.0.8 → 0.0.9

package/contracts/doc-versions.mjs

@@ -1,3 +1,3 @@
-export const PACKAGE_VERSION = "0.0.8";
+export const PACKAGE_VERSION = "0.0.9";
 
 export const DOC_VERSIONS = [PACKAGE_VERSION];

package/contracts/index.mjs

@@ -1,4 +1,5 @@
 export { DOC_VERSIONS } from "./doc-versions.mjs";
+export { PDF_GUIDE_FILENAME } from "../data/path-mappings.mjs";
 export {
   DEFAULT_LAYOUTS_DIR,
   LAYOUTS_CONFIG_FILENAME,

package/data/default-site-config.mjs

@@ -14,7 +14,45 @@ export function getDefaultSiteConfig(projectLink, languageToggles = buildLanguag
         ThemeDefault: "aurora-dark",
         ThemeModeDefault: "dark",
         ActiveNavigation: true,
+        IconQuickNavigationReactIcones: false,
+        IconQuickNavigationReactIconesTag: "FiSearch",
+        IconQuickNavigationReactIconesTagColorDark: "currentColor",
+        IconQuickNavigationReactIconesTagColorLight: "currentColor",
+        IconQuickNavigationReactIconesTagSize: "22px",
         FocusMode: true,
+        focusMode: {
+            copyEnabled: true,
+            downloadEnabled: true,
+            sectionNavigationEnabled: true,
+            documentNavigationEnabled: true,
+        },
+        nestedMenusEnabled: true,
+        pdf: {
+            enabled: true,
+            previewEnabled: true,
+            downloadEnabled: true,
+            openInNewTabEnabled: true,
+        },
+        RouteGuide: true,
+        accessibility: {
+            enabled: true,
+            narration: { enabled: true, defaultRate: 1, defaultVolume: 1 },
+        },
+        IconLanguageSelectorReactIcones: false,
+        IconLanguageSelectorReactIconesTag: "FiGlobe",
+        IconLanguageSelectorReactIconesTagColorDark: "currentColor",
+        IconLanguageSelectorReactIconesTagColorLight: "currentColor",
+        IconLanguageSelectorReactIconesTagSize: "22px",
+        IconThemeSelectorReactIcones: false,
+        IconThemeSelectorReactIconesTag: "BsSunFill",
+        IconThemeSelectorReactIconesTagColorDark: "currentColor",
+        IconThemeSelectorReactIconesTagColorLight: "currentColor",
+        IconThemeSelectorReactIconesTagSize: "22px",
+        IconFocusModeReactIcones: false,
+        IconFocusModeReactIconesTag: "MdFullscreen",
+        IconFocusModeReactIconesTagColorDark: "currentColor",
+        IconFocusModeReactIconesTagColorLight: "currentColor",
+        IconFocusModeReactIconesTagSize: "22px",
         FooterEnabled: true,
         FooterLinkName: "GitPageDocs",
         FooterLinkUrl: projectLink,

package/data/i18n-langmenu.mjs

@@ -1,5 +1,11 @@
 export const defaultLangMenu = {
         pt: {
+          titleHeaderMenuPdf: "PDF",
+          PdfDownload: "Baixar PDF",
+          PdfOpenInNewTab: "Abrir PDF em nova aba",
+          PdfUnavailable: "A prévia do PDF depende do navegador. Use as ações disponíveis para abrir ou baixar o documento.",
+          PdfDownloadError: "Não foi possível baixar o PDF. Tente abrir o documento em uma nova aba.",
+          PdfDownloading: "Baixando PDF...",
           pt: "Portugues",
           en: "Ingles",
           es: "Espanhol",
@@ -19,6 +25,27 @@ export const defaultLangMenu = {
           typeToNavigate: "Digite para navegar...",
           noNavigationResults: "Nenhum resultado de navegacao.",
           focusMode: "Modo foco",
+          focusSectionsLabel: "Seções",
+          focusDocumentsLabel: "Documentos",
+          focusPreviousSectionLabel: "Seção anterior",
+          focusNextSectionLabel: "Próxima seção",
+          focusPreviousDocumentLabel: "Documento anterior",
+          focusNextDocumentLabel: "Próximo documento",
+          narrationTitle: "Acessibilidade e leitura",
+          narrationStart: "Ler documento",
+          narrationPause: "Pausar leitura",
+          narrationResume: "Retomar leitura",
+          narrationStop: "Parar leitura",
+          narrationVoice: "Voz do navegador",
+          narrationAutomaticVoice: "Automática pelo idioma do documento",
+          narrationRate: "Velocidade",
+          narrationVolume: "Volume",
+          narrationUnsupported: "Este navegador não oferece narração de texto.",
+          narrationError: "Não foi possível narrar. Escolha outra voz ou tente novamente.",
+          narrationReady: "Pronto para ler",
+          narrationSpeaking: "Lendo documento",
+          narrationPaused: "Leitura pausada",
+          narrationSettingsHint: "As vozes são fornecidas pelo navegador. Pare a leitura para alterar as preferências.",
           versionLinksLabel: "Links do repositorio",
           titleHeaderMenuMd: "Markdown",
           titleHeaderMenuSourceViewer: "Codigo fonte",
@@ -137,6 +164,12 @@ export const defaultLangMenu = {
           docsAccessBlockCancelBtn: "Cancelar",
         },
         en: {
+          titleHeaderMenuPdf: "PDF",
+          PdfDownload: "Download PDF",
+          PdfOpenInNewTab: "Open PDF in a new tab",
+          PdfUnavailable: "PDF preview depends on your browser. Use the available actions to open or download the document.",
+          PdfDownloadError: "The PDF could not be downloaded. Try opening the document in a new tab.",
+          PdfDownloading: "Downloading PDF...",
           pt: "Portuguese",
           en: "English",
           es: "Spanish",
@@ -156,6 +189,27 @@ export const defaultLangMenu = {
           typeToNavigate: "Type to navigate...",
           noNavigationResults: "No navigation results.",
           focusMode: "Focus mode",
+          focusSectionsLabel: "Sections",
+          focusDocumentsLabel: "Documents",
+          focusPreviousSectionLabel: "Previous section",
+          focusNextSectionLabel: "Next section",
+          focusPreviousDocumentLabel: "Previous document",
+          focusNextDocumentLabel: "Next document",
+          narrationTitle: "Accessibility and reading",
+          narrationStart: "Read document",
+          narrationPause: "Pause reading",
+          narrationResume: "Resume reading",
+          narrationStop: "Stop reading",
+          narrationVoice: "Browser voice",
+          narrationAutomaticVoice: "Automatic for the document language",
+          narrationRate: "Speed",
+          narrationVolume: "Volume",
+          narrationUnsupported: "This browser does not support text narration.",
+          narrationError: "Could not read aloud. Choose another voice or try again.",
+          narrationReady: "Ready to read",
+          narrationSpeaking: "Reading document",
+          narrationPaused: "Reading paused",
+          narrationSettingsHint: "Voices are supplied by your browser. Stop reading to change preferences.",
           versionLinksLabel: "Repository links",
           titleHeaderMenuMd: "Markdown",
           titleHeaderMenuSourceViewer: "Source code",
@@ -274,6 +328,12 @@ export const defaultLangMenu = {
           docsAccessBlockCancelBtn: "Cancel",
         },
         es: {
+          titleHeaderMenuPdf: "PDF",
+          PdfDownload: "Descargar PDF",
+          PdfOpenInNewTab: "Abrir PDF en una pestaña nueva",
+          PdfUnavailable: "La vista previa del PDF depende del navegador. Usa las acciones disponibles para abrir o descargar el documento.",
+          PdfDownloadError: "No se pudo descargar el PDF. Intenta abrir el documento en una pestaña nueva.",
+          PdfDownloading: "Descargando PDF...",
           pt: "Portugues",
           en: "Ingles",
           es: "Espanol",
@@ -293,6 +353,27 @@ export const defaultLangMenu = {
           typeToNavigate: "Escribe para navegar...",
           noNavigationResults: "Sin resultados de navegacion.",
           focusMode: "Modo foco",
+          focusSectionsLabel: "Secciones",
+          focusDocumentsLabel: "Documentos",
+          focusPreviousSectionLabel: "Sección anterior",
+          focusNextSectionLabel: "Siguiente sección",
+          focusPreviousDocumentLabel: "Documento anterior",
+          focusNextDocumentLabel: "Siguiente documento",
+          narrationTitle: "Accesibilidad y lectura",
+          narrationStart: "Leer documento",
+          narrationPause: "Pausar lectura",
+          narrationResume: "Reanudar lectura",
+          narrationStop: "Detener lectura",
+          narrationVoice: "Voz del navegador",
+          narrationAutomaticVoice: "Automática según el idioma del documento",
+          narrationRate: "Velocidad",
+          narrationVolume: "Volumen",
+          narrationUnsupported: "Este navegador no admite narración de texto.",
+          narrationError: "No se pudo leer. Elige otra voz o inténtalo de nuevo.",
+          narrationReady: "Listo para leer",
+          narrationSpeaking: "Leyendo documento",
+          narrationPaused: "Lectura pausada",
+          narrationSettingsHint: "El navegador proporciona las voces. Detén la lectura para cambiar las preferencias.",
           versionLinksLabel: "Enlaces del repositorio",
           titleHeaderMenuMd: "Markdown",
           titleHeaderMenuSourceViewer: "Codigo fuente",

package/data/path-mappings.mjs

@@ -1,5 +1,7 @@
 /** Path and media mappings for doc versions */
 
+export const PDF_GUIDE_FILENAME = "gitpagedocs-project-guide.pdf";
+
 export const ROUTE_PATHS = {
   1: { pt: "getting-started.md", en: "getting-started.md", es: "getting-started.md" },
   2: { pt: "project-overview.md", en: "project-overview.md", es: "project-overview.md" },
@@ -7,6 +9,17 @@ export const ROUTE_PATHS = {
   4: { pt: "github-issues-projects.md", en: "github-issues-projects.md", es: "github-issues-projects.md" },
   5: { pt: "git-introduction.md", en: "git-introduction.md", es: "git-introduction.md" },
   6: { pt: "authorized-routes.md", en: "authorized-routes.md", es: "authorized-routes.md" },
+  13: { pt: "configuration.md", en: "configuration.md", es: "configuration.md" },
+  14: { pt: "deployment.md", en: "deployment.md", es: "deployment.md" },
+  15: { pt: "architecture.md", en: "architecture.md", es: "architecture.md" },
+  16: { pt: "themes.md", en: "themes.md", es: "themes.md" },
+  17: { pt: "faq.md", en: "faq.md", es: "faq.md" },
+  18: { pt: "cli.md", en: "cli.md", es: "cli.md" },
+  19: { pt: "mcp.md", en: "mcp.md", es: "mcp.md" },
+  20: { pt: "navigation.md", en: "navigation.md", es: "navigation.md" },
+  21: { pt: "accessibility.md", en: "accessibility.md", es: "accessibility.md" },
+  22: { pt: "focus-mode.md", en: "focus-mode.md", es: "focus-mode.md" },
+  24: { pt: "pdf.md", en: "pdf.md", es: "pdf.md" },
 };
 
 export const VIDEO_IDS = ["bdIJkGr2NV0", "c67GaAkf1BE", "N3my6W_Rdwg", "r8jQ9hVA2qs"];

package/data/route-metas.mjs

@@ -1,8 +1,8 @@
 /** Route and video metadata for doc versions */
 
-export const DEFAULT_HIERARCHY = { md: 0, "source-viewer": 1, html: 2, video: 3, audio: 4 };
+export const DEFAULT_HIERARCHY = { md: 0, "source-viewer": 1, html: 2, video: 3, audio: 4, pdf: 5 };
 /** Page order that puts the video container above the markdown. */
-export const VIDEO_FIRST_HIERARCHY = { video: 0, md: 1, "source-viewer": 2, html: 3, audio: 4 };
+export const VIDEO_FIRST_HIERARCHY = { video: 0, md: 1, "source-viewer": 2, html: 3, audio: 4, pdf: 5 };
 
 export const ROUTE_META_ID1 = {
   titles: { pt: "Primeiros passos", en: "Getting Started", es: "Primeros pasos" },
@@ -38,6 +38,53 @@ export const ROUTE_META_ID6 = {
   },
 };
 
+export const REFERENCE_ROUTE_METAS = {
+  13: {
+    titles: { pt: "Configuração", en: "Configuration", es: "Configuración" },
+    descriptions: { pt: "Idiomas, ícones, navegação, foco e acessibilidade", en: "Languages, icons, navigation, focus and accessibility", es: "Idiomas, iconos, navegación, foco y accesibilidad" },
+  },
+  14: {
+    titles: { pt: "Publicação", en: "Deployment", es: "Publicación" },
+    descriptions: { pt: "Execução local e publicação no GitHub Pages", en: "Local runtime and GitHub Pages deployment", es: "Ejecución local y publicación en GitHub Pages" },
+  },
+  15: {
+    titles: { pt: "Arquitetura", en: "Architecture", es: "Arquitectura" },
+    descriptions: { pt: "Pacotes, contratos e fluxo de dados", en: "Packages, contracts and data flow", es: "Paquetes, contratos y flujo de datos" },
+  },
+  16: {
+    titles: { pt: "Temas e layouts", en: "Themes and layouts", es: "Temas y diseños" },
+    descriptions: { pt: "Personalize templates e tokens visuais", en: "Customize templates and visual tokens", es: "Personaliza plantillas y tokens visuales" },
+  },
+  17: {
+    titles: { pt: "Perguntas frequentes", en: "FAQ", es: "Preguntas frecuentes" },
+    descriptions: { pt: "Diagnóstico e solução de problemas", en: "Diagnostics and troubleshooting", es: "Diagnóstico y solución de problemas" },
+  },
+  18: {
+    titles: { pt: "Referência da CLI", en: "CLI reference", es: "Referencia de la CLI" },
+    descriptions: { pt: "Instalação, comandos, opções e exemplos", en: "Installation, commands, options and examples", es: "Instalación, comandos, opciones y ejemplos" },
+  },
+  19: {
+    titles: { pt: "Servidor MCP", en: "MCP server", es: "Servidor MCP" },
+    descriptions: { pt: "Instalação, clientes, tools, resources e provedores", en: "Installation, clients, tools, resources and providers", es: "Instalación, clientes, tools, resources y proveedores" },
+  },
+  20: {
+    titles: { pt: "Navegação e submenus", en: "Navigation and nested menus", es: "Navegación y submenús" },
+    descriptions: { pt: "Árvores recursivas, URLs e breadcrumbs", en: "Recursive trees, URLs and breadcrumbs", es: "Árboles recursivos, URLs y breadcrumbs" },
+  },
+  21: {
+    titles: { pt: "Acessibilidade e narração", en: "Accessibility and narration", es: "Accesibilidad y narración" },
+    descriptions: { pt: "Leitura com vozes nativas do navegador", en: "Reading with native browser voices", es: "Lectura con voces nativas del navegador" },
+  },
+  22: {
+    titles: { pt: "Modo foco", en: "Focus mode", es: "Modo foco" },
+    descriptions: { pt: "Leitura, cópia, download e navegação entre documentos", en: "Reading, copy, download and document navigation", es: "Lectura, copia, descarga y navegación entre documentos" },
+  },
+  24: {
+    titles: { pt: "Documentos PDF", en: "PDF documents", es: "Documentos PDF" },
+    descriptions: { pt: "Rotas, prévia, download e publicação de anexos PDF", en: "Routes, previews, downloads and publishing PDF attachments", es: "Rutas, vista previa, descarga y publicación de anexos PDF" },
+  },
+};
+
 export const SOURCE_VIEWER_META = {
   id: 7,
   titles: { pt: "Codigo fonte", en: "Source code", es: "Codigo fuente" },
@@ -58,6 +105,16 @@ export const AUDIO_META_ID12 = {
   },
 };
 
+export const PDF_GUIDE_META = {
+  id: 23,
+  titles: { pt: "Guia do projeto em PDF (inglês)", en: "Project guide PDF (English)", es: "Guía del proyecto en PDF (inglés)" },
+  descriptions: {
+    pt: "Visualize ou baixe o guia do GitPageDocs em inglês.",
+    en: "Preview or download the GitPageDocs project guide in English.",
+    es: "Visualiza o descarga la guía de GitPageDocs en inglés.",
+  },
+};
+
 export const VIDEO_META_ID1 = {
   title: { pt: "Interactive vs non-interactive modes | Copilot CLI for beginners", en: "Interactive vs non-interactive modes | Copilot CLI for beginners", es: "Interactive vs non-interactive modes | Copilot CLI for beginners" },
   description: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gitpagedocs/cli",
-  "version": "0.0.8",
+  "version": "0.0.9",
   "description": "CLI that scaffolds and maintains gitpagedocs documentation, generates docs with AI, configures GitHub Pages, and runs the MCP server.",
   "bin": {
     "gitpagedocs": "index.mjs"
@@ -29,8 +29,8 @@
   },
   "dependencies": {
     "@clack/prompts": "^1.5.1",
-    "@gitpagedocs/mcp": "^0.0.8",
-    "@gitpagedocs/tools": "^0.0.8",
+    "@gitpagedocs/mcp": "^0.0.9",
+    "@gitpagedocs/tools": "^0.0.9",
     "tsx": "^4.21.0"
   },
   "repository": {

package/runtime/doc-path-resolver.mjs

@@ -1,19 +1,28 @@
 /** Map doc paths to content keys and apply version badges */
 
+const DOC_FILE_KEYS = new Map([
+  ["index.md", "index"],
+  ["getting-started.md", "gettingStarted"],
+  ["configuration.md", "configuration"],
+  ["deployment.md", "deployment"],
+  ["architecture.md", "architecture"],
+  ["themes.md", "themes"],
+  ["faq.md", "faq"],
+  ["project-overview.md", "projectOverview"],
+  ["functionalities.md", "functionalities"],
+  ["github-issues-projects.md", "githubIssuesProjects"],
+  ["git-introduction.md", "gitIntroduction"],
+  ["authorized-routes.md", "authorizedRoutes"],
+  ["cli.md", "cli"],
+  ["mcp.md", "mcp"],
+  ["navigation.md", "navigation"],
+  ["accessibility.md", "accessibility"],
+  ["focus-mode.md", "focusMode"],
+  ["pdf.md", "pdf"],
+]);
+
 export function parseDocFileToKey(fileName) {
-  if (fileName === "index.md") return "index";
-  if (fileName === "getting-started.md") return "gettingStarted";
-  if (fileName === "configuration.md") return "configuration";
-  if (fileName === "deployment.md") return "deployment";
-  if (fileName === "architecture.md") return "architecture";
-  if (fileName === "themes.md") return "themes";
-  if (fileName === "faq.md") return "faq";
-  if (fileName === "project-overview.md") return "projectOverview";
-  if (fileName === "functionalities.md") return "functionalities";
-  if (fileName === "github-issues-projects.md") return "githubIssuesProjects";
-  if (fileName === "git-introduction.md") return "gitIntroduction";
-  if (fileName === "authorized-routes.md") return "authorizedRoutes";
-  return undefined;
+  return DOC_FILE_KEYS.get(fileName);
 }
 
 export function parseHtmlFileToKey(fileName) {

package/runtime/output.mjs

@@ -1,5 +1,5 @@
 import { existsSync } from "node:fs";
-import { mkdir, writeFile } from "node:fs/promises";
+import { copyFile, mkdir, writeFile } from "node:fs/promises";
 import path from "node:path";
 import {
   parseDocFileToKey,
@@ -11,6 +11,7 @@ import {
 import { layoutsArtifactPaths } from "../contracts/layouts-paths.mjs";
 import { languageArtifactPaths } from "../contracts/langs-paths.mjs";
 import { SUPPORTED_LANGUAGES } from "../contracts/languages.mjs";
+import { PDF_GUIDE_FILENAME } from "../data/path-mappings.mjs";
 import { compactSiteIcons, factorRouteDefaults } from "@gitpagedocs/tools/config-format";
 
 const DEFAULT_ICON_SVG = `<?xml version="1.0" encoding="utf-8"?>
@@ -160,4 +161,18 @@ export async function writeConfigOnlyOutput(options) {
 
 
   await writeVersionedDocs(root, outputDir, artifacts);
+  await writePdfArtifacts(options);
+}
+
+async function writePdfArtifacts({ root, pkgRoot, outputDir, artifacts }) {
+  const source = path.join(pkgRoot, "content", "assets", PDF_GUIDE_FILENAME);
+  for (const [versionId, versionConfig] of Object.entries(artifacts.versionConfigs)) {
+    const bundledPath = `gitpagedocs/docs/versions/${versionId}/en/${PDF_GUIDE_FILENAME}`;
+    const routes = versionConfig["routes-pdf"] ?? [];
+    const usesBundledGuide = routes.some((route) => Object.values(route.pdf?.pathPdf ?? {}).includes(bundledPath));
+    if (!usesBundledGuide) continue;
+    const destination = path.join(root, normalizeToOutputPath(outputDir, bundledPath));
+    await mkdir(path.dirname(destination), { recursive: true });
+    await copyFile(source, destination);
+  }
 }