@gitpagedocs/cli 0.0.9 → 0.0.10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/builders/config-orchestrator.mjs +2 -1
- package/builders/version-config-builder.mjs +53 -8
- package/content/assets/gitpagedocs-project-guide.pdf +34 -34
- package/content/configuration-examples.mjs +62 -0
- package/content/docs-en.mjs +52 -18
- package/content/docs-es.mjs +54 -19
- package/content/docs-pt.mjs +54 -19
- package/content/html-doom.mjs +155 -0
- package/content/operations-en.mjs +70 -0
- package/content/operations-es.mjs +70 -0
- package/content/operations-pt.mjs +70 -0
- package/content/practical-en.mjs +116 -0
- package/content/practical-es.mjs +116 -0
- package/content/practical-pt.mjs +116 -0
- package/contracts/doc-versions.mjs +1 -1
- package/data/default-site-config.mjs +24 -4
- package/data/i18n-langmenu.mjs +15 -0
- package/data/menu-sections.mjs +46 -0
- package/data/path-mappings.mjs +6 -0
- package/data/route-metas.mjs +30 -0
- package/package.json +3 -3
- package/runtime/doc-path-resolver.mjs +6 -0
package/content/docs-en.mjs
CHANGED
|
@@ -1,6 +1,10 @@
|
|
|
1
1
|
import { PACKAGE_VERSION } from "../contracts/doc-versions.mjs";
|
|
2
|
+
import { practicalEn } from "./practical-en.mjs";
|
|
3
|
+
import { operationsEn } from "./operations-en.mjs";
|
|
2
4
|
|
|
3
5
|
export const docsEn = {
|
|
6
|
+
...practicalEn,
|
|
7
|
+
...operationsEn,
|
|
4
8
|
pdf: `# PDF documents
|
|
5
9
|
|
|
6
10
|
PDF is a first-class content type alongside Markdown, HTML, source code, video and audio. The viewer uses the browser's native PDF preview. Download and open-in-new-tab actions remain independently configurable.
|
|
@@ -26,13 +30,15 @@ Add this block inside \`site\` in \`gitpagedocs/config.json\`:
|
|
|
26
30
|
}
|
|
27
31
|
\`\`\`
|
|
28
32
|
|
|
29
|
-
\`enabled\` is the master switch for PDF content. The other fields control the preview, download button and new-tab
|
|
33
|
+
\`enabled\` is the master switch for PDF content. The other fields control the preview, download button and new-tab button. Every field defaults to \`true\` when omitted, including older configurations.
|
|
30
34
|
|
|
31
35
|
Action precedence is \`route.pdf.<flag>\` > \`site.pdf.<flag>\` > \`true\`. An explicit route \`true\` enables that action even when its site default is \`false\`; \`site.pdf.enabled: false\` still disables PDF content everywhere. A missing path for the selected language makes the PDF unavailable; there is no automatic language fallback.
|
|
32
36
|
|
|
37
|
+
PDF actions use icons by default. Configure \`site.icons.PdfDownload\` (\`FiDownload\`) and \`site.icons.PdfOpenInNewTab\` (\`FiExternalLink\`) independently with \`reactIcon\`, \`tag\`, \`size\`, \`colorDark\` and \`colorLight\`. For example, \`"PdfDownload": { "reactIcon": false }\` shows download text while the new-tab action remains an icon. Changing appearance does not change the action flags above.
|
|
38
|
+
|
|
33
39
|
## Route and menu example
|
|
34
40
|
|
|
35
|
-
In \`gitpagedocs/docs/versions/0.0.
|
|
41
|
+
In \`gitpagedocs/docs/versions/0.0.10/config.json\`, keep route and menu arrays at the top level:
|
|
36
42
|
|
|
37
43
|
\`\`\`json
|
|
38
44
|
{
|
|
@@ -41,9 +47,9 @@ In \`gitpagedocs/docs/versions/0.0.9/config.json\`, keep route and menu arrays a
|
|
|
41
47
|
"title": { "en": "Project guide (English)", "pt": "Guia do projeto (inglês)", "es": "Guía del proyecto (inglés)" },
|
|
42
48
|
"pdf": {
|
|
43
49
|
"pathPdf": {
|
|
44
|
-
"en": "gitpagedocs/docs/versions/0.0.
|
|
45
|
-
"pt": "gitpagedocs/docs/versions/0.0.
|
|
46
|
-
"es": "gitpagedocs/docs/versions/0.0.
|
|
50
|
+
"en": "gitpagedocs/docs/versions/0.0.10/en/gitpagedocs-project-guide.pdf",
|
|
51
|
+
"pt": "gitpagedocs/docs/versions/0.0.10/en/gitpagedocs-project-guide.pdf",
|
|
52
|
+
"es": "gitpagedocs/docs/versions/0.0.10/en/gitpagedocs-project-guide.pdf"
|
|
47
53
|
},
|
|
48
54
|
"previewEnabled": true,
|
|
49
55
|
"downloadEnabled": true,
|
|
@@ -67,9 +73,9 @@ The optional route flags live inside \`pdf\`. Shared presentation, \`container\`
|
|
|
67
73
|
|
|
68
74
|
Repository-root paths beginning with \`gitpagedocs/\` are copied into the viewer's public assets when Next.js starts or builds. The URL respects the configured deployment subpath on GitHub Pages. Keep the PDF tracked in Git and publish it with the generated documentation. Assets outside \`gitpagedocs/\` must already be in the viewer's \`frontend/public/\` directory or be reachable through an HTTP(S) URL.
|
|
69
75
|
|
|
70
|
-
Use the binary PDF URL, not an HTML repository preview URL. For remote repositories, the configured path resolves against that repository.
|
|
76
|
+
Use the binary PDF URL, not an HTML repository preview URL. For remote repositories, the configured path resolves against that repository. Preview, download and opening a new tab fetch the file bytes, so an external server must allow CORS for all three actions. The viewer validates the PDF signature and creates a temporary \`application/pdf\` Blob URL. Preview and new-tab viewing use the browser's native PDF viewer; the origin server's framing policy and MIME/disposition headers do not control the Blob view.
|
|
71
77
|
|
|
72
|
-
The new-tab
|
|
78
|
+
The new-tab button opens the validated PDF Blob instead of navigating to the raw repository URL. This also works when preview is disabled: loading starts when the reader downloads or opens the document. Previously loaded bytes are reused for the current PDF. Network/CORS failures, invalid PDFs and blocked new tabs produce a visible error; there is no automatic fallback to the raw URL. Native PDF support and the browser's own download preferences still determine how the new tab displays the file.
|
|
73
79
|
|
|
74
80
|
## Reading and troubleshooting
|
|
75
81
|
|
|
@@ -77,7 +83,7 @@ The new-tab link opens the original URL directly. Its behavior depends on the br
|
|
|
77
83
|
- Preview does not convert the PDF to Markdown. Markdown focus mode, section navigation, copy-as-Markdown and narration operate on Markdown documents, not the embedded PDF.
|
|
78
84
|
- Disabling preview can keep the download and new-tab actions available. Turning off every PDF action leaves no interactive PDF control.
|
|
79
85
|
- A disabled button is not access control. Publicly hosted PDFs remain downloadable by URL. Use protected hosting for confidential documents.
|
|
80
|
-
- If a preview is blank,
|
|
86
|
+
- If a preview is blank, verify that the path returns a PDF and that CORS permits access, then try the new-tab action. Allow pop-ups for the site if the browser blocks that action. Download and new-tab failures are reported on the page.
|
|
81
87
|
`,
|
|
82
88
|
index: `# Git Page Docs
|
|
83
89
|
|
|
@@ -120,6 +126,13 @@ The runtime expects this structure:
|
|
|
120
126
|
- **Focus mode**: copy/download Markdown and section/document navigation.
|
|
121
127
|
- **Accessibility and narration**: browser voices, controls and media interaction.
|
|
122
128
|
- **PDF documents**: native previews, download/new-tab controls and the included English guide.
|
|
129
|
+
- **Configuration recipes**: a complete multilingual site and a menu with sections inside sections.
|
|
130
|
+
- **Migration and compatibility**: upgrade configurations from 0.0.1 onward while preserving your content.
|
|
131
|
+
- **Troubleshooting**: UTF-8, local and Pages paths, PDF loading, browser voices and MCP startup.
|
|
132
|
+
- **Contributing and validation**: source files, generation, public contracts and release checks.
|
|
133
|
+
- **HTML containers**: local and external pages, route/menu configuration and the interactive DOOM example.
|
|
134
|
+
|
|
135
|
+
The generated menu keeps Getting Started and Project overview first. Guides contains Configure your site, Read and explore, and Automate and integrate; each category contains its related pages. Operations and development groups publishing, maintenance and contribution guides. Git and GitHub contains the repository examples. Categories can contain further categories without a fixed nesting limit.
|
|
123
136
|
`,
|
|
124
137
|
gettingStarted: `# Getting Started
|
|
125
138
|
|
|
@@ -413,9 +426,9 @@ Behavior:
|
|
|
413
426
|
- If \`layoutsConfigPathOficial=true\`, runtime prefers official layout/template sources.
|
|
414
427
|
- If \`layoutsConfigPathOficial=false\`, runtime prefers repository-local/custom layout sources.
|
|
415
428
|
|
|
416
|
-
## Language, theme and
|
|
429
|
+
## Language, theme, focus, quick navigation, PDF and document controls
|
|
417
430
|
|
|
418
|
-
In \`gitpagedocs/config.json\`,
|
|
431
|
+
In \`gitpagedocs/config.json\`, these \`site.icons\` entries configure the language selector, theme selector, focus, Ctrl+K navigation, PDF actions and document-footer navigation. All eight controls use React Icons by default:
|
|
419
432
|
|
|
420
433
|
\`\`\`json
|
|
421
434
|
{
|
|
@@ -436,13 +449,31 @@ In \`gitpagedocs/config.json\`, merge these entries into \`site.icons\` to use R
|
|
|
436
449
|
"QuickNavigation": {
|
|
437
450
|
"reactIcon": true, "tag": "FiSearch", "size": "22px",
|
|
438
451
|
"colorDark": "currentColor", "colorLight": "currentColor"
|
|
452
|
+
},
|
|
453
|
+
"PdfDownload": {
|
|
454
|
+
"reactIcon": true, "tag": "FiDownload", "size": "22px",
|
|
455
|
+
"colorDark": "currentColor", "colorLight": "currentColor"
|
|
456
|
+
},
|
|
457
|
+
"PdfOpenInNewTab": {
|
|
458
|
+
"reactIcon": true, "tag": "FiExternalLink", "size": "22px",
|
|
459
|
+
"colorDark": "currentColor", "colorLight": "currentColor"
|
|
460
|
+
},
|
|
461
|
+
"DocumentPrevious": {
|
|
462
|
+
"reactIcon": true, "tag": "FiChevronLeft", "size": "22px",
|
|
463
|
+
"colorDark": "currentColor", "colorLight": "currentColor"
|
|
464
|
+
},
|
|
465
|
+
"DocumentNext": {
|
|
466
|
+
"reactIcon": true, "tag": "FiChevronRight", "size": "22px",
|
|
467
|
+
"colorDark": "currentColor", "colorLight": "currentColor"
|
|
439
468
|
}
|
|
440
469
|
}
|
|
441
470
|
}
|
|
442
471
|
}
|
|
443
472
|
\`\`\`
|
|
444
473
|
|
|
445
|
-
Each control is independent: \`reactIcon:
|
|
474
|
+
Each control is independent: \`reactIcon: true\` shows its icon (the default); \`false\` displays text. Customize \`tag\`, \`size\`, \`colorDark\` and \`colorLight\` per control; \`currentColor\` follows the active theme. Icon controls keep their accessible names, and selectors keep their menus. The Ctrl+K shortcut remains available. \`site.FocusMode\` still enables focus mode; \`site.icons.FocusMode\` only changes the button's appearance. \`site.icons.PdfDownload\` and \`site.icons.PdfOpenInNewTab\` independently select text or icons; the corresponding \`site.pdf\` and route \`pdf\` flags control whether each action is available.
|
|
475
|
+
|
|
476
|
+
Compact configs may move shared values into \`site.icons.defaults\`; omitted fields inherit those defaults. Set \`reactIcon: false\` on a specific entry to override the default icon presentation with text.
|
|
446
477
|
|
|
447
478
|
## \`VersionControl\` section
|
|
448
479
|
|
|
@@ -512,7 +543,7 @@ Per-route options for \`routes-md\`, \`routes-html\`, \`routes-video\`, and \`ro
|
|
|
512
543
|
|
|
513
544
|
| Key | Default / purpose |
|
|
514
545
|
| --- | --- |
|
|
515
|
-
| \`ActiveNavigation\` | true;
|
|
546
|
+
| \`ActiveNavigation\` | true; quick-navigation control and Ctrl+K shortcut |
|
|
516
547
|
| \`FocusMode / focusMode\` | Master switch (true) and independent copy, download, section and document controls; see Focus mode |
|
|
517
548
|
| \`pdf\` | PDF master switch, preview, download and new-tab defaults; all true |
|
|
518
549
|
| \`nestedMenusEnabled\` | true; recursive menu tree, or flat destinations when false |
|
|
@@ -953,7 +984,9 @@ The tree supplies sidebar navigation, search labels, parent expansion and breadc
|
|
|
953
984
|
|
|
954
985
|
## URLs and previous/next
|
|
955
986
|
|
|
956
|
-
Versioned URLs use \`/v/<version>/\`; \`?lang=pt\` selects a language and \`?id=101\` selects a page ID. \`?name=chapter\` selects the document slug. Keep \`VersionControl.versions[].path\` pointing at the matching version config. \`site.ActiveNavigation\` enables
|
|
987
|
+
Versioned URLs use \`/v/<version>/\`; \`?lang=pt\` selects a language and \`?id=101\` selects a page ID. \`?name=chapter\` selects the document slug. Keep \`VersionControl.versions[].path\` pointing at the matching version config. \`site.ActiveNavigation\` enables quick navigation and its Ctrl+K shortcut. Footer previous/next controls follow available menu destinations; focus-mode document navigation has its own option. See Focus mode for its section and document controls.
|
|
988
|
+
|
|
989
|
+
Footer previous/next buttons use \`site.icons.DocumentPrevious\` (\`FiChevronLeft\`) and \`site.icons.DocumentNext\` (\`FiChevronRight\`) by default. Set \`reactIcon: false\` on either entry to show its translated text; each entry also accepts \`tag\`, \`size\`, \`colorDark\` and \`colorLight\`. Appearance does not change navigation: the footer appears when more than one menu destination is available, and the unavailable direction stays disabled at the ends.
|
|
957
990
|
|
|
958
991
|
Test a new menu from the sidebar, by direct URL and in each enabled language; verify the destination exists and is allowed for the current reader.
|
|
959
992
|
`,
|
|
@@ -979,15 +1012,16 @@ Merge this fragment into \`gitpagedocs/config.json\`:
|
|
|
979
1012
|
}
|
|
980
1013
|
\`\`\`
|
|
981
1014
|
|
|
982
|
-
Each option defaults to \`true\`; setting one to \`false\` hides its corresponding
|
|
1015
|
+
Each option defaults to \`true\`; setting one to \`false\` hides its corresponding action or navigation group. With \`sectionNavigationEnabled: false\`, focus mode displays the entire document without section pagination. Existing configurations without the new \`focusMode\` object keep the controls enabled.
|
|
983
1016
|
|
|
984
1017
|
## Sections and documents
|
|
985
1018
|
|
|
986
|
-
-
|
|
987
|
-
-
|
|
1019
|
+
- Section navigation has four buttons: first section, previous section, next section and last section of the current document.
|
|
1020
|
+
- Document navigation has four buttons: first document, previous document, next document and last document in menu order, including nested menus.
|
|
1021
|
+
- \`sectionNavigationEnabled\` controls the four section buttons; \`documentNavigationEnabled\` controls the four document buttons. Unavailable directions are disabled at the ends.
|
|
988
1022
|
- Documents without a translation in the active language, non-Markdown destinations and inaccessible pages are skipped.
|
|
989
1023
|
- Switching documents keeps the dialog open and starts at the first section. Section/document counters show the current position.
|
|
990
|
-
- \`site.ActiveNavigation\` controls the
|
|
1024
|
+
- \`site.ActiveNavigation\` controls the quick-navigation interface; it does not disable focus-mode document navigation.
|
|
991
1025
|
|
|
992
1026
|
## Copy and download
|
|
993
1027
|
|
|
@@ -1092,7 +1126,7 @@ Because GitHub Pages build mode enables repository-search home and static-export
|
|
|
1092
1126
|
|
|
1093
1127
|
## Why does an icon still show text?
|
|
1094
1128
|
|
|
1095
|
-
Set \`site.icons.<Control>.reactIcon\` to the boolean \`true\`, with an exact React Icons export name in \`tag\`.
|
|
1129
|
+
Set \`site.icons.<Control>.reactIcon\` to the boolean \`true\`, with an exact React Icons export name in \`tag\`. LanguageSelector, ThemeSelector, FocusMode, QuickNavigation, PdfDownload, PdfOpenInNewTab, DocumentPrevious and DocumentNext use icons by default; set any entry to \`false\` for text. Flat \`Icon*ReactIcones\` fields take precedence if both formats are present. Check whether the feature itself is disabled, such as \`HideThemeSelector\`, \`FocusMode\` or the PDF action flags.
|
|
1096
1130
|
|
|
1097
1131
|
## Why do menu children or breadcrumbs differ?
|
|
1098
1132
|
|
package/content/docs-es.mjs
CHANGED
|
@@ -1,4 +1,9 @@
|
|
|
1
|
+
import { practicalEs } from "./practical-es.mjs";
|
|
2
|
+
import { operationsEs } from "./operations-es.mjs";
|
|
3
|
+
|
|
1
4
|
export const docsEs = {
|
|
5
|
+
...practicalEs,
|
|
6
|
+
...operationsEs,
|
|
2
7
|
pdf: `# Documentos PDF
|
|
3
8
|
|
|
4
9
|
PDF es un tipo de contenido propio junto con Markdown, HTML, código fuente, vídeo y audio. La vista previa utiliza el visor nativo de PDF del navegador. Las acciones de descarga y apertura en una pestaña nueva se configuran de forma independiente.
|
|
@@ -24,13 +29,15 @@ Añade este bloque dentro de \`site\` en \`gitpagedocs/config.json\`:
|
|
|
24
29
|
}
|
|
25
30
|
\`\`\`
|
|
26
31
|
|
|
27
|
-
\`enabled\` es el interruptor general del contenido PDF. Los demás campos controlan la vista previa, el botón de descarga y el
|
|
32
|
+
\`enabled\` es el interruptor general del contenido PDF. Los demás campos controlan la vista previa, el botón de descarga y el botón de nueva pestaña. Cada campo omitido toma el valor \`true\`, también en configuraciones antiguas.
|
|
28
33
|
|
|
29
34
|
La precedencia de las acciones es \`ruta.pdf.<flag>\` > \`site.pdf.<flag>\` > \`true\`. Un \`true\` explícito en la ruta activa esa acción aunque el valor del sitio sea \`false\`; \`site.pdf.enabled: false\` sigue desactivando todos los PDFs. Si falta la ruta del idioma seleccionado, el PDF no está disponible; no hay cambio automático de idioma.
|
|
30
35
|
|
|
36
|
+
Las acciones PDF usan iconos por defecto. Configura \`site.icons.PdfDownload\` (\`FiDownload\`) y \`site.icons.PdfOpenInNewTab\` (\`FiExternalLink\`) por separado con \`reactIcon\`, \`tag\`, \`size\`, \`colorDark\` y \`colorLight\`. Por ejemplo, \`"PdfDownload": { "reactIcon": false }\` muestra texto en descarga mientras la nueva pestaña conserva su icono. La apariencia no cambia las opciones de activación anteriores.
|
|
37
|
+
|
|
31
38
|
## Ejemplo de ruta y menú
|
|
32
39
|
|
|
33
|
-
En \`gitpagedocs/docs/versions/0.0.
|
|
40
|
+
En \`gitpagedocs/docs/versions/0.0.10/config.json\`, conserva las listas de rutas y menús en el nivel principal:
|
|
34
41
|
|
|
35
42
|
\`\`\`json
|
|
36
43
|
{
|
|
@@ -39,9 +46,9 @@ En \`gitpagedocs/docs/versions/0.0.9/config.json\`, conserva las listas de rutas
|
|
|
39
46
|
"title": { "en": "Project guide (English)", "pt": "Guia do projeto (inglês)", "es": "Guía del proyecto (inglés)" },
|
|
40
47
|
"pdf": {
|
|
41
48
|
"pathPdf": {
|
|
42
|
-
"en": "gitpagedocs/docs/versions/0.0.
|
|
43
|
-
"pt": "gitpagedocs/docs/versions/0.0.
|
|
44
|
-
"es": "gitpagedocs/docs/versions/0.0.
|
|
49
|
+
"en": "gitpagedocs/docs/versions/0.0.10/en/gitpagedocs-project-guide.pdf",
|
|
50
|
+
"pt": "gitpagedocs/docs/versions/0.0.10/en/gitpagedocs-project-guide.pdf",
|
|
51
|
+
"es": "gitpagedocs/docs/versions/0.0.10/en/gitpagedocs-project-guide.pdf"
|
|
45
52
|
},
|
|
46
53
|
"previewEnabled": true,
|
|
47
54
|
"downloadEnabled": true,
|
|
@@ -65,9 +72,9 @@ Las opciones de la ruta se colocan dentro de \`pdf\`. La presentación compartid
|
|
|
65
72
|
|
|
66
73
|
Las rutas relativas a la raíz del repositorio que empiezan por \`gitpagedocs/\` se copian a los assets públicos del visor al iniciar o compilar Next.js. La URL respeta el subdirectorio de publicación de GitHub Pages. Incluye el PDF en Git y publícalo junto con la documentación generada. Los archivos fuera de \`gitpagedocs/\` deben estar en \`frontend/public/\` del visor o ser accesibles mediante una URL HTTP(S).
|
|
67
74
|
|
|
68
|
-
Usa la URL del PDF binario, no una página HTML de vista previa del repositorio. Para repositorios remotos, la ruta se resuelve dentro de ese repositorio.
|
|
75
|
+
Usa la URL del PDF binario, no una página HTML de vista previa del repositorio. Para repositorios remotos, la ruta se resuelve dentro de ese repositorio. La vista previa, la descarga y la apertura en una nueva pestaña obtienen los bytes del archivo, por lo que un servidor externo debe permitir CORS para las tres acciones. El visor valida la firma PDF y crea una URL Blob temporal de tipo \`application/pdf\`. La vista previa y la nueva pestaña utilizan el visor PDF nativo del navegador; la política de incorporación y las cabeceras de tipo/disposición del servidor de origen no controlan esta vista Blob.
|
|
69
76
|
|
|
70
|
-
El
|
|
77
|
+
El botón de nueva pestaña abre el Blob PDF validado en lugar de navegar a la URL raw del repositorio. También funciona con la vista previa desactivada: la carga comienza cuando el lector descarga o abre el documento. Los bytes cargados se reutilizan para el PDF actual. Los fallos de red/CORS, los PDFs inválidos y el bloqueo de nuevas pestañas muestran un error; no hay fallback automático a la URL raw. El soporte PDF nativo y las preferencias de descarga del navegador siguen determinando cómo se muestra el archivo en la nueva pestaña.
|
|
71
78
|
|
|
72
79
|
## Lectura y diagnóstico
|
|
73
80
|
|
|
@@ -75,7 +82,7 @@ El enlace de nueva pestaña abre directamente la URL original. Su comportamiento
|
|
|
75
82
|
- La vista previa no convierte PDF en Markdown. El modo foco, la navegación por secciones, la copia de Markdown y la narración actúan sobre documentos Markdown, no sobre el PDF incorporado.
|
|
76
83
|
- Desactivar la vista previa puede conservar la descarga y la nueva pestaña. Desactivar todas las acciones deja el PDF sin controles interactivos.
|
|
77
84
|
- Ocultar un botón no controla el acceso. Los PDFs alojados públicamente siguen disponibles mediante su URL. Los documentos confidenciales necesitan alojamiento protegido.
|
|
78
|
-
- Si la vista previa está vacía,
|
|
85
|
+
- Si la vista previa está vacía, confirma que la ruta devuelve un PDF y permite acceso mediante CORS; después prueba la nueva pestaña. Permite ventanas emergentes para el sitio si el navegador bloquea esa acción. Los fallos de descarga y apertura se muestran en la página.
|
|
79
86
|
`,
|
|
80
87
|
index: `# Git Page Docs
|
|
81
88
|
|
|
@@ -118,6 +125,13 @@ El runtime espera esta estructura:
|
|
|
118
125
|
- **Modo foco**: copiar/descargar Markdown y navegar por sección/documento.
|
|
119
126
|
- **Accesibilidad y narración**: voces del navegador, controles e interacción con medios.
|
|
120
127
|
- **Documentos PDF**: vista previa nativa, descarga/nueva pestaña y la guía incluida en inglés.
|
|
128
|
+
- **Recetas de configuración**: un sitio multilingüe completo y un menú con secciones dentro de secciones.
|
|
129
|
+
- **Migración y compatibilidad**: actualizar configuraciones desde la versión 0.0.1 conservando tu contenido.
|
|
130
|
+
- **Solución de problemas**: UTF-8, rutas locales y de Pages, carga de PDF, voces e inicio de MCP.
|
|
131
|
+
- **Contribución y validación**: archivos fuente, generación, contratos públicos y comprobaciones de publicación.
|
|
132
|
+
- **Contenedores HTML**: páginas locales y externas, configuración de rutas/menús y el ejemplo interactivo DOOM.
|
|
133
|
+
|
|
134
|
+
El menú generado mantiene Primeros pasos y la descripción general del proyecto al principio. Guías contiene Configura tu sitio, Lee y explora y Automatiza e integra; cada categoría contiene sus páginas relacionadas. Operación y desarrollo agrupa publicación, mantenimiento y contribución. Git y GitHub contiene los ejemplos del repositorio. Las categorías pueden contener otras categorías sin un límite fijo de niveles.
|
|
121
135
|
`,
|
|
122
136
|
gettingStarted: `# Primeros pasos
|
|
123
137
|
|
|
@@ -277,7 +291,7 @@ Claves principales:
|
|
|
277
291
|
- \`ThemeModeDefault\`: modo inicial (\`light\` o \`dark\`)
|
|
278
292
|
- \`ProjectLink\`: URL de repositorio para acciones de cabecera
|
|
279
293
|
- \`docsVersion\`: version seleccionada por defecto
|
|
280
|
-
- \`ActiveNavigation\`: habilita
|
|
294
|
+
- \`ActiveNavigation\`: habilita la navegación rápida y el atajo Ctrl+K
|
|
281
295
|
- \`FocusMode\`: habilita modo foco/lectura
|
|
282
296
|
- \`icons\`: iconos de la cabecera. \`icons.defaults\` guarda lo que todos comparten (\`reactIcon\`, \`colorDark\`, \`colorLight\`, \`size\`, \`imgDark\`, \`imgLight\`, \`imgWidth\`, \`imgHeight\`) y cada icono define su \`tag\` y lo que cambia (\`null\` quita un campo). Las claves planas de abajo siguen valiendo y ganan cuando existen ambas formas.
|
|
283
297
|
- \`IconImageMenuHeaderImgWidth\`, \`IconImageMenuHeaderImgHeight\`: tamano del icono principal
|
|
@@ -293,9 +307,9 @@ Claves principales:
|
|
|
293
307
|
- \`layoutsConfigPath\`: fallback remoto de layouts
|
|
294
308
|
- \`rendering\`: URL canonica publicada
|
|
295
309
|
|
|
296
|
-
## Controles de idioma, tema y
|
|
310
|
+
## Controles de idioma, tema, foco, navegación rápida, PDF y documentos
|
|
297
311
|
|
|
298
|
-
En \`gitpagedocs/config.json\`,
|
|
312
|
+
En \`gitpagedocs/config.json\`, estas entradas de \`site.icons\` configuran idioma, tema, foco, navegación Ctrl+K, acciones PDF y navegación al pie de los documentos. Los ocho controles utilizan React Icons por defecto:
|
|
299
313
|
|
|
300
314
|
\`\`\`json
|
|
301
315
|
{
|
|
@@ -316,13 +330,31 @@ En \`gitpagedocs/config.json\`, agrega estas entradas a \`site.icons\` para usar
|
|
|
316
330
|
"QuickNavigation": {
|
|
317
331
|
"reactIcon": true, "tag": "FiSearch", "size": "22px",
|
|
318
332
|
"colorDark": "currentColor", "colorLight": "currentColor"
|
|
333
|
+
},
|
|
334
|
+
"PdfDownload": {
|
|
335
|
+
"reactIcon": true, "tag": "FiDownload", "size": "22px",
|
|
336
|
+
"colorDark": "currentColor", "colorLight": "currentColor"
|
|
337
|
+
},
|
|
338
|
+
"PdfOpenInNewTab": {
|
|
339
|
+
"reactIcon": true, "tag": "FiExternalLink", "size": "22px",
|
|
340
|
+
"colorDark": "currentColor", "colorLight": "currentColor"
|
|
341
|
+
},
|
|
342
|
+
"DocumentPrevious": {
|
|
343
|
+
"reactIcon": true, "tag": "FiChevronLeft", "size": "22px",
|
|
344
|
+
"colorDark": "currentColor", "colorLight": "currentColor"
|
|
345
|
+
},
|
|
346
|
+
"DocumentNext": {
|
|
347
|
+
"reactIcon": true, "tag": "FiChevronRight", "size": "22px",
|
|
348
|
+
"colorDark": "currentColor", "colorLight": "currentColor"
|
|
319
349
|
}
|
|
320
350
|
}
|
|
321
351
|
}
|
|
322
352
|
}
|
|
323
353
|
\`\`\`
|
|
324
354
|
|
|
325
|
-
Cada control es independiente: \`reactIcon:
|
|
355
|
+
Cada control es independiente: \`reactIcon: true\` muestra el icono (por defecto); \`false\` muestra texto. Personaliza \`tag\`, \`size\`, \`colorDark\` y \`colorLight\` por control; \`currentColor\` sigue el tema activo. Los controles con iconos conservan sus nombres accesibles, y los selectores conservan sus menús. El atajo Ctrl+K sigue disponible. \`site.FocusMode\` habilita el modo foco; \`site.icons.FocusMode\` solo cambia la apariencia del botón. \`site.icons.PdfDownload\` y \`site.icons.PdfOpenInNewTab\` seleccionan texto o iconos independientemente; las opciones correspondientes de \`site.pdf\` y del \`pdf\` de la ruta controlan la disponibilidad de cada acción.
|
|
356
|
+
|
|
357
|
+
Las configuraciones compactas pueden mover valores comunes a \`site.icons.defaults\`; los campos omitidos heredan esos valores. Define \`reactIcon: false\` en una entrada concreta para sustituir el icono predeterminado por texto.
|
|
326
358
|
|
|
327
359
|
## Seccion \`VersionControl\`
|
|
328
360
|
|
|
@@ -389,7 +421,7 @@ Opciones por ruta en \`routes-md\`, \`routes-html\` y \`routes-video\`:
|
|
|
389
421
|
|
|
390
422
|
| Clave | Valor / finalidad |
|
|
391
423
|
| --- | --- |
|
|
392
|
-
| \`ActiveNavigation\` | true;
|
|
424
|
+
| \`ActiveNavigation\` | true; navegación rápida y atajo Ctrl+K |
|
|
393
425
|
| \`FocusMode / focusMode\` | Activación general (true) y controles independientes de copia, descarga, sección y documento; consulta Modo foco |
|
|
394
426
|
| \`pdf\` | Activación general, vista previa, descarga y nueva pestaña; todos true |
|
|
395
427
|
| \`nestedMenusEnabled\` | true; árbol recursivo, o destinos planos con false |
|
|
@@ -905,7 +937,9 @@ El árbol sirve para navegación lateral, etiquetas de búsqueda, expansión de
|
|
|
905
937
|
|
|
906
938
|
## URLs y anterior/siguiente
|
|
907
939
|
|
|
908
|
-
Las URLs versionadas utilizan \`/v/<version>/\`; \`?lang=pt\` elige el idioma y \`?id=101\` elige la página. \`?name=chapter\` selecciona el slug del documento. Mantén \`VersionControl.versions[].path\` apuntando al config de la versión correspondiente. \`site.ActiveNavigation\` activa anterior/siguiente
|
|
940
|
+
Las URLs versionadas utilizan \`/v/<version>/\`; \`?lang=pt\` elige el idioma y \`?id=101\` elige la página. \`?name=chapter\` selecciona el slug del documento. Mantén \`VersionControl.versions[].path\` apuntando al config de la versión correspondiente. \`site.ActiveNavigation\` activa la navegación rápida y su atajo Ctrl+K. Los controles anterior/siguiente del pie siguen los destinos disponibles en el menú; la navegación entre documentos en modo foco tiene su propia opción. Consulta Modo foco para controles de sección y documento.
|
|
941
|
+
|
|
942
|
+
Los botones anterior/siguiente del pie usan \`site.icons.DocumentPrevious\` (\`FiChevronLeft\`) y \`site.icons.DocumentNext\` (\`FiChevronRight\`) por defecto. Define \`reactIcon: false\` en cualquier entrada para mostrar su texto traducido; cada entrada también acepta \`tag\`, \`size\`, \`colorDark\` y \`colorLight\`. La apariencia no cambia la navegación: el pie aparece cuando hay más de un destino disponible en el menú, y la dirección no disponible permanece desactivada en los extremos.
|
|
909
943
|
|
|
910
944
|
Prueba un menú nuevo desde la barra lateral, por URL directa y en cada idioma habilitado; confirma que el destino existe y está permitido para el lector actual.
|
|
911
945
|
`,
|
|
@@ -931,15 +965,16 @@ Combina este fragmento con \`gitpagedocs/config.json\`:
|
|
|
931
965
|
}
|
|
932
966
|
\`\`\`
|
|
933
967
|
|
|
934
|
-
Cada opción tiene valor predeterminado \`true\`; \`false\` oculta
|
|
968
|
+
Cada opción tiene valor predeterminado \`true\`; \`false\` oculta la acción o el grupo de navegación correspondiente. Con \`sectionNavigationEnabled: false\`, el modo foco muestra el documento completo sin paginación por secciones. Las configuraciones existentes sin el nuevo objeto \`focusMode\` mantienen los controles activados.
|
|
935
969
|
|
|
936
970
|
## Secciones y documentos
|
|
937
971
|
|
|
938
|
-
-
|
|
939
|
-
-
|
|
972
|
+
- La navegación por secciones tiene cuatro botones: primera sección, sección anterior, sección siguiente y última sección del documento actual.
|
|
973
|
+
- La navegación por documentos tiene cuatro botones: primer documento, documento anterior, documento siguiente y último documento en el orden del menú, incluidos los submenús.
|
|
974
|
+
- \`sectionNavigationEnabled\` controla los cuatro botones de sección; \`documentNavigationEnabled\` controla los cuatro botones de documento. Las direcciones no disponibles quedan desactivadas en los extremos.
|
|
940
975
|
- Se omiten documentos sin traducción en el idioma activo, destinos que no son Markdown y páginas sin permiso.
|
|
941
976
|
- Cambiar de documento mantiene abierto el diálogo y vuelve a la primera sección. Los contadores de sección/documento muestran la posición actual.
|
|
942
|
-
- \`site.ActiveNavigation\` controla la navegación
|
|
977
|
+
- \`site.ActiveNavigation\` controla la navegación rápida; no desactiva la navegación de documentos en modo foco.
|
|
943
978
|
|
|
944
979
|
## Copiar y descargar
|
|
945
980
|
|
|
@@ -1044,7 +1079,7 @@ Porque el build de GitHub Pages habilita la pagina inicial de busqueda y comport
|
|
|
1044
1079
|
|
|
1045
1080
|
## ¿Por qué el icono sigue mostrando texto?
|
|
1046
1081
|
|
|
1047
|
-
Define \`site.icons.<Control>.reactIcon\` como booleano \`true\`, con el nombre exacto exportado por React Icons en \`tag\`.
|
|
1082
|
+
Define \`site.icons.<Control>.reactIcon\` como booleano \`true\`, con el nombre exacto exportado por React Icons en \`tag\`. LanguageSelector, ThemeSelector, FocusMode, QuickNavigation, PdfDownload, PdfOpenInNewTab, DocumentPrevious y DocumentNext usan iconos por defecto; cambia cualquier entrada a \`false\` para mostrar texto. Los campos planos \`Icon*ReactIcones\` tienen prioridad si existen ambos formatos. Comprueba si la propia función está desactivada mediante \`HideThemeSelector\`, \`FocusMode\` o las acciones PDF.
|
|
1048
1083
|
|
|
1049
1084
|
## ¿Por qué los hijos del menú o breadcrumbs son diferentes?
|
|
1050
1085
|
|
package/content/docs-pt.mjs
CHANGED
|
@@ -1,4 +1,9 @@
|
|
|
1
|
+
import { practicalPt } from "./practical-pt.mjs";
|
|
2
|
+
import { operationsPt } from "./operations-pt.mjs";
|
|
3
|
+
|
|
1
4
|
export const docsPt = {
|
|
5
|
+
...practicalPt,
|
|
6
|
+
...operationsPt,
|
|
2
7
|
pdf: `# Documentos PDF
|
|
3
8
|
|
|
4
9
|
PDF é um tipo de conteúdo próprio, junto com Markdown, HTML, código-fonte, vídeo e áudio. A prévia usa o visualizador nativo de PDF do navegador. As ações de baixar e abrir em nova aba são configuráveis de forma independente.
|
|
@@ -24,13 +29,15 @@ Adicione este bloco dentro de \`site\` em \`gitpagedocs/config.json\`:
|
|
|
24
29
|
}
|
|
25
30
|
\`\`\`
|
|
26
31
|
|
|
27
|
-
\`enabled\` é a chave geral do conteúdo PDF. Os demais campos controlam a prévia, o botão de download e o
|
|
32
|
+
\`enabled\` é a chave geral do conteúdo PDF. Os demais campos controlam a prévia, o botão de download e o botão de nova aba. Todo campo omitido assume \`true\`, inclusive em configurações antigas.
|
|
28
33
|
|
|
29
34
|
A precedência das ações é \`rota.pdf.<flag>\` > \`site.pdf.<flag>\` > \`true\`. Um \`true\` explícito na rota habilita aquela ação mesmo quando o padrão do site é \`false\`; \`site.pdf.enabled: false\` continua desabilitando todos os PDFs. Sem caminho para o idioma selecionado, o PDF fica indisponível; não há fallback automático de idioma.
|
|
30
35
|
|
|
36
|
+
As ações PDF usam ícones por padrão. Configure \`site.icons.PdfDownload\` (\`FiDownload\`) e \`site.icons.PdfOpenInNewTab\` (\`FiExternalLink\`) individualmente com \`reactIcon\`, \`tag\`, \`size\`, \`colorDark\` e \`colorLight\`. Por exemplo, \`"PdfDownload": { "reactIcon": false }\` exibe texto no download enquanto a nova aba continua com ícone. A aparência não altera as opções de habilitação acima.
|
|
37
|
+
|
|
31
38
|
## Exemplo de rota e menu
|
|
32
39
|
|
|
33
|
-
Em \`gitpagedocs/docs/versions/0.0.
|
|
40
|
+
Em \`gitpagedocs/docs/versions/0.0.10/config.json\`, mantenha as listas de rotas e menus no nível principal:
|
|
34
41
|
|
|
35
42
|
\`\`\`json
|
|
36
43
|
{
|
|
@@ -39,9 +46,9 @@ Em \`gitpagedocs/docs/versions/0.0.9/config.json\`, mantenha as listas de rotas
|
|
|
39
46
|
"title": { "en": "Project guide (English)", "pt": "Guia do projeto (inglês)", "es": "Guía del proyecto (inglés)" },
|
|
40
47
|
"pdf": {
|
|
41
48
|
"pathPdf": {
|
|
42
|
-
"en": "gitpagedocs/docs/versions/0.0.
|
|
43
|
-
"pt": "gitpagedocs/docs/versions/0.0.
|
|
44
|
-
"es": "gitpagedocs/docs/versions/0.0.
|
|
49
|
+
"en": "gitpagedocs/docs/versions/0.0.10/en/gitpagedocs-project-guide.pdf",
|
|
50
|
+
"pt": "gitpagedocs/docs/versions/0.0.10/en/gitpagedocs-project-guide.pdf",
|
|
51
|
+
"es": "gitpagedocs/docs/versions/0.0.10/en/gitpagedocs-project-guide.pdf"
|
|
45
52
|
},
|
|
46
53
|
"previewEnabled": true,
|
|
47
54
|
"downloadEnabled": true,
|
|
@@ -65,9 +72,9 @@ As flags opcionais da rota ficam dentro de \`pdf\`. Apresentação compartilhada
|
|
|
65
72
|
|
|
66
73
|
Caminhos relativos à raiz do repositório que começam com \`gitpagedocs/\` são copiados para os assets públicos do visualizador ao iniciar ou compilar o Next.js. A URL respeita o subdiretório de publicação no GitHub Pages. Versione o PDF no Git e publique-o junto com a documentação gerada. Arquivos fora de \`gitpagedocs/\` devem estar em \`frontend/public/\` do visualizador ou acessíveis por uma URL HTTP(S).
|
|
67
74
|
|
|
68
|
-
Use a URL do PDF binário, não uma página HTML de prévia do repositório. Em repositórios remotos, o caminho configurado é resolvido nesse repositório.
|
|
75
|
+
Use a URL do PDF binário, não uma página HTML de prévia do repositório. Em repositórios remotos, o caminho configurado é resolvido nesse repositório. Prévia, download e abertura em nova aba buscam os bytes do arquivo, portanto um servidor externo precisa permitir CORS nas três ações. O visualizador valida a assinatura PDF e cria uma URL Blob temporária com tipo \`application/pdf\`. A prévia e a nova aba usam o visualizador nativo de PDF do navegador; a política de incorporação e os cabeçalhos de tipo/disposição do servidor de origem não controlam essa exibição Blob.
|
|
69
76
|
|
|
70
|
-
O
|
|
77
|
+
O botão de nova aba abre o Blob PDF validado em vez de navegar para a URL raw do repositório. Isso também funciona com a prévia desabilitada: o carregamento começa quando o leitor baixa ou abre o documento. Os bytes já carregados são reutilizados para o PDF atual. Falhas de rede/CORS, PDFs inválidos e bloqueio da nova aba geram um erro visível; não há fallback automático para a URL raw. O suporte nativo a PDF e as preferências de download do navegador ainda determinam como a nova aba exibe o arquivo.
|
|
71
78
|
|
|
72
79
|
## Leitura e diagnóstico
|
|
73
80
|
|
|
@@ -75,7 +82,7 @@ O link de nova aba abre diretamente a URL original. Seu comportamento depende do
|
|
|
75
82
|
- A prévia não converte PDF em Markdown. Modo foco, navegação por seção, cópia de Markdown e narração atuam em documentos Markdown, não no PDF incorporado.
|
|
76
83
|
- Desabilitar a prévia pode manter download e nova aba disponíveis. Desabilitar todas as ações deixa o PDF sem controle interativo.
|
|
77
84
|
- Ocultar um botão não controla acesso. PDFs hospedados publicamente continuam acessíveis pela URL. Documentos confidenciais precisam de hospedagem protegida.
|
|
78
|
-
- Se a prévia estiver vazia,
|
|
85
|
+
- Se a prévia estiver vazia, confira se o caminho retorna um PDF e permite acesso por CORS; depois tente a nova aba. Permita pop-ups para o site se o navegador bloquear essa ação. Falhas de download e abertura são informadas na página.
|
|
79
86
|
`,
|
|
80
87
|
index: `# Git Page Docs
|
|
81
88
|
|
|
@@ -118,6 +125,13 @@ O runtime espera esta estrutura:
|
|
|
118
125
|
- **Modo foco**: copiar/baixar Markdown e navegar por seção/documento.
|
|
119
126
|
- **Acessibilidade e narração**: vozes do navegador, controles e interação com mídias.
|
|
120
127
|
- **Documentos PDF**: prévia nativa, download/nova aba e o guia incluído em inglês.
|
|
128
|
+
- **Receitas de configuração**: um site multilíngue completo e um menu com seções dentro de seções.
|
|
129
|
+
- **Migração e compatibilidade**: atualizar configurações desde a versão 0.0.1 preservando seu conteúdo.
|
|
130
|
+
- **Solução de problemas**: UTF-8, caminhos locais e do Pages, carregamento de PDF, vozes e inicialização do MCP.
|
|
131
|
+
- **Contribuição e validação**: arquivos fonte, geração, contratos públicos e verificações de publicação.
|
|
132
|
+
- **Containers HTML**: páginas locais e externas, configuração de rotas/menus e o exemplo interativo DOOM.
|
|
133
|
+
|
|
134
|
+
O menu gerado mantém Primeiros passos e Visão geral do projeto no início. Guias contém Configure seu site, Leia e explore e Automatize e integre; cada categoria contém suas páginas relacionadas. Operação e desenvolvimento agrupa publicação, manutenção e contribuição. Git e GitHub contém os exemplos de repositório. As categorias podem conter outras categorias sem um limite fixo de níveis.
|
|
121
135
|
`,
|
|
122
136
|
gettingStarted: `# Primeiros passos
|
|
123
137
|
|
|
@@ -277,7 +291,7 @@ Principais chaves:
|
|
|
277
291
|
- \`ThemeModeDefault\`: modo inicial (\`light\` ou \`dark\`)
|
|
278
292
|
- \`ProjectLink\`: URL de repositorio para acoes no cabecalho
|
|
279
293
|
- \`docsVersion\`: versao inicial selecionada
|
|
280
|
-
- \`ActiveNavigation\`: habilita
|
|
294
|
+
- \`ActiveNavigation\`: habilita a navegação rápida e o atalho Ctrl+K
|
|
281
295
|
- \`FocusMode\`: habilita modo foco/leitura
|
|
282
296
|
- \`icons\`: icones do cabecalho. \`icons.defaults\` guarda o que todos compartilham (\`reactIcon\`, \`colorDark\`, \`colorLight\`, \`size\`, \`imgDark\`, \`imgLight\`, \`imgWidth\`, \`imgHeight\`) e cada icone define seu \`tag\` e o que muda (\`null\` remove um campo). As chaves planas abaixo continuam valendo e vencem quando as duas formas existem.
|
|
283
297
|
- \`IconImageMenuHeaderImgWidth\`, \`IconImageMenuHeaderImgHeight\`: tamanho do icone principal
|
|
@@ -293,9 +307,9 @@ Principais chaves:
|
|
|
293
307
|
- \`layoutsConfigPath\`: fallback remoto para layouts
|
|
294
308
|
- \`rendering\`: URL canonica publicada
|
|
295
309
|
|
|
296
|
-
## Controles de idioma, tema e
|
|
310
|
+
## Controles de idioma, tema, foco, navegação rápida, PDF e documentos
|
|
297
311
|
|
|
298
|
-
Em \`gitpagedocs/config.json\`,
|
|
312
|
+
Em \`gitpagedocs/config.json\`, estas entradas de \`site.icons\` configuram idioma, tema, foco, navegação Ctrl+K, ações PDF e navegação no rodapé dos documentos. Os oito controles usam React Icons por padrão:
|
|
299
313
|
|
|
300
314
|
\`\`\`json
|
|
301
315
|
{
|
|
@@ -316,13 +330,31 @@ Em \`gitpagedocs/config.json\`, adicione estas entradas a \`site.icons\` para us
|
|
|
316
330
|
"QuickNavigation": {
|
|
317
331
|
"reactIcon": true, "tag": "FiSearch", "size": "22px",
|
|
318
332
|
"colorDark": "currentColor", "colorLight": "currentColor"
|
|
333
|
+
},
|
|
334
|
+
"PdfDownload": {
|
|
335
|
+
"reactIcon": true, "tag": "FiDownload", "size": "22px",
|
|
336
|
+
"colorDark": "currentColor", "colorLight": "currentColor"
|
|
337
|
+
},
|
|
338
|
+
"PdfOpenInNewTab": {
|
|
339
|
+
"reactIcon": true, "tag": "FiExternalLink", "size": "22px",
|
|
340
|
+
"colorDark": "currentColor", "colorLight": "currentColor"
|
|
341
|
+
},
|
|
342
|
+
"DocumentPrevious": {
|
|
343
|
+
"reactIcon": true, "tag": "FiChevronLeft", "size": "22px",
|
|
344
|
+
"colorDark": "currentColor", "colorLight": "currentColor"
|
|
345
|
+
},
|
|
346
|
+
"DocumentNext": {
|
|
347
|
+
"reactIcon": true, "tag": "FiChevronRight", "size": "22px",
|
|
348
|
+
"colorDark": "currentColor", "colorLight": "currentColor"
|
|
319
349
|
}
|
|
320
350
|
}
|
|
321
351
|
}
|
|
322
352
|
}
|
|
323
353
|
\`\`\`
|
|
324
354
|
|
|
325
|
-
Cada controle
|
|
355
|
+
Cada controle é independente: \`reactIcon: true\` mostra o ícone (padrão); \`false\` exibe texto. Personalize \`tag\`, \`size\`, \`colorDark\` e \`colorLight\` por controle; \`currentColor\` acompanha o tema ativo. Controles com ícone mantêm seus nomes acessíveis, e seletores mantêm os menus. O atalho Ctrl+K continua disponível. \`site.FocusMode\` ainda habilita o modo foco; \`site.icons.FocusMode\` só altera a aparência do botão. \`site.icons.PdfDownload\` e \`site.icons.PdfOpenInNewTab\` selecionam texto ou ícone de forma independente; as opções correspondentes em \`site.pdf\` e no \`pdf\` da rota controlam a disponibilidade de cada ação.
|
|
356
|
+
|
|
357
|
+
Configs compactos podem mover valores comuns para \`site.icons.defaults\`; campos omitidos herdam esses defaults. Defina \`reactIcon: false\` em uma entrada específica para substituir o ícone padrão por texto.
|
|
326
358
|
|
|
327
359
|
## Secao \`VersionControl\`
|
|
328
360
|
|
|
@@ -389,7 +421,7 @@ Opcoes por rota em \`routes-md\`, \`routes-html\` e \`routes-video\`:
|
|
|
389
421
|
|
|
390
422
|
| Chave | Padrão / finalidade |
|
|
391
423
|
| --- | --- |
|
|
392
|
-
| \`ActiveNavigation\` | true;
|
|
424
|
+
| \`ActiveNavigation\` | true; navegação rápida e atalho Ctrl+K |
|
|
393
425
|
| \`FocusMode / focusMode\` | Habilitação geral (true) e controles independentes de cópia, download, seção e documento; consulte Modo foco |
|
|
394
426
|
| \`pdf\` | Habilitação geral, prévia, download e nova aba; todos true |
|
|
395
427
|
| \`nestedMenusEnabled\` | true; árvore recursiva, ou destinos em lista plana quando false |
|
|
@@ -905,7 +937,9 @@ A árvore atende à navegação lateral, aos rótulos de busca, à expansão dos
|
|
|
905
937
|
|
|
906
938
|
## URLs e anterior/próximo
|
|
907
939
|
|
|
908
|
-
URLs versionadas usam \`/v/<version>/\`; \`?lang=pt\` escolhe o idioma e \`?id=101\` escolhe a página. \`?name=chapter\` seleciona o slug do documento. Mantenha \`VersionControl.versions[].path\` apontando para o config da versão correspondente. \`site.ActiveNavigation\` ativa anterior/próximo
|
|
940
|
+
URLs versionadas usam \`/v/<version>/\`; \`?lang=pt\` escolhe o idioma e \`?id=101\` escolhe a página. \`?name=chapter\` seleciona o slug do documento. Mantenha \`VersionControl.versions[].path\` apontando para o config da versão correspondente. \`site.ActiveNavigation\` ativa a navegação rápida e seu atalho Ctrl+K. Os controles anterior/próximo do rodapé seguem os destinos disponíveis no menu; a navegação entre documentos no modo foco possui opção própria. Consulte Modo foco para os controles de seção e documento.
|
|
941
|
+
|
|
942
|
+
Os botões Voltar/Próximo do rodapé usam \`site.icons.DocumentPrevious\` (\`FiChevronLeft\`) e \`site.icons.DocumentNext\` (\`FiChevronRight\`) por padrão. Defina \`reactIcon: false\` em qualquer entrada para exibir seu texto traduzido; cada entrada também aceita \`tag\`, \`size\`, \`colorDark\` e \`colorLight\`. A aparência não muda a navegação: o rodapé aparece quando há mais de um destino disponível no menu, e a direção indisponível continua desabilitada nas extremidades.
|
|
909
943
|
|
|
910
944
|
Teste um menu novo pela lateral, por URL direta e em cada idioma habilitado; confirme que o destino existe e é permitido para o leitor atual.
|
|
911
945
|
`,
|
|
@@ -931,15 +965,16 @@ Mescle este fragmento em \`gitpagedocs/config.json\`:
|
|
|
931
965
|
}
|
|
932
966
|
\`\`\`
|
|
933
967
|
|
|
934
|
-
Cada opção tem padrão \`true\`; \`false\` oculta
|
|
968
|
+
Cada opção tem padrão \`true\`; \`false\` oculta a ação ou o grupo de navegação correspondente. Com \`sectionNavigationEnabled: false\`, o modo foco exibe o documento inteiro sem paginação por seções. Configurações existentes sem o novo objeto \`focusMode\` mantêm os controles habilitados.
|
|
935
969
|
|
|
936
970
|
## Seções e documentos
|
|
937
971
|
|
|
938
|
-
-
|
|
939
|
-
-
|
|
972
|
+
- A navegação de seções possui quatro botões: primeira seção, seção anterior, próxima seção e última seção do documento atual.
|
|
973
|
+
- A navegação de documentos possui quatro botões: primeiro documento, documento anterior, próximo documento e último documento na ordem dos menus, incluindo submenus.
|
|
974
|
+
- \`sectionNavigationEnabled\` controla os quatro botões de seção; \`documentNavigationEnabled\` controla os quatro botões de documento. Direções indisponíveis ficam desabilitadas nas extremidades.
|
|
940
975
|
- Documentos sem tradução no idioma ativo, destinos sem Markdown e páginas sem permissão são ignorados.
|
|
941
976
|
- Trocar de documento mantém o diálogo aberto e volta à primeira seção. Contadores de seção/documento mostram a posição atual.
|
|
942
|
-
- \`site.ActiveNavigation\` controla a navegação
|
|
977
|
+
- \`site.ActiveNavigation\` controla a navegação rápida; não desabilita a navegação de documentos no modo foco.
|
|
943
978
|
|
|
944
979
|
## Copiar e baixar
|
|
945
980
|
|
|
@@ -1044,7 +1079,7 @@ Porque o build de GitHub Pages habilita pagina inicial de busca e comportamento
|
|
|
1044
1079
|
|
|
1045
1080
|
## Por que o ícone ainda mostra texto?
|
|
1046
1081
|
|
|
1047
|
-
Defina \`site.icons.<Controle>.reactIcon\` como booleano \`true\`, com o nome exato exportado por React Icons em \`tag\`.
|
|
1082
|
+
Defina \`site.icons.<Controle>.reactIcon\` como booleano \`true\`, com o nome exato exportado por React Icons em \`tag\`. LanguageSelector, ThemeSelector, FocusMode, QuickNavigation, PdfDownload, PdfOpenInNewTab, DocumentPrevious e DocumentNext usam ícones por padrão; altere qualquer entrada para \`false\` para exibir texto. Campos planos \`Icon*ReactIcones\` prevalecem se os dois formatos existirem. Confira se o próprio recurso está desabilitado por opções como \`HideThemeSelector\`, \`FocusMode\` ou as ações PDF.
|
|
1048
1083
|
|
|
1049
1084
|
## Por que filhos de menus ou breadcrumbs aparecem diferentes?
|
|
1050
1085
|
|