@gitpagedocs/cli 0.0.11 → 0.0.13
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/README.md +27 -7
- package/ai/application/run-ai-cli-command.ts +2 -2
- package/builders/theme-template.mjs +3 -0
- package/content/configuration-examples.mjs +1 -0
- package/content/docs-en.mjs +32 -11
- package/content/docs-es.mjs +33 -12
- package/content/docs-pt.mjs +37 -16
- package/content/practical-en.mjs +4 -4
- package/content/practical-es.mjs +4 -4
- package/content/practical-pt.mjs +4 -4
- package/content/theme-backgrounds.mjs +241 -0
- package/contracts/doc-versions.mjs +2 -2
- package/data/animated-layouts.mjs +7583 -0
- package/data/default-site-config.mjs +24 -0
- package/data/i18n-langmenu.mjs +9 -0
- package/data/layouts.mjs +4 -1
- package/data/theme-colors.mjs +4 -1
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -28,7 +28,8 @@ npx @gitpagedocs/cli
|
|
|
28
28
|
| `gitpagedocs provider [id]` · `models [provider]` | List AI providers / catalog models |
|
|
29
29
|
| `gitpagedocs document[:repo\|:file\|:folder]` | Generate documentation with AI in the gitpagedocs pattern |
|
|
30
30
|
| `gitpagedocs password` | Set a documentation access password (writes the public key to `config.json`, prints the private key) |
|
|
31
|
-
| `gitpagedocs deploy` / `pages
|
|
31
|
+
| `gitpagedocs deploy` / `pages deploy` | Configure GitHub Pages via Actions, generate, commit and push |
|
|
32
|
+
| `gitpagedocs pages actions` | Switch the repository's Pages source to GitHub Actions; no generation or push |
|
|
32
33
|
| `gitpagedocs docs` | Refresh managed regions of README/CONTRIBUTING/SECURITY |
|
|
33
34
|
| `gitpagedocs config clear` | Delete the stored `.gitpagedocsconfig` **and** the encrypted key vault `.gitpagedocsvault` (wipes saved AI credentials) |
|
|
34
35
|
| `gitpagedocs doctor` · `version` · `update` | Diagnostics / version / registry update check |
|
|
@@ -36,6 +37,24 @@ npx @gitpagedocs/cli
|
|
|
36
37
|
|
|
37
38
|
The AI-CLI implementation lives in `cli/ai/` (relocated from the frontend so the published package is self-contained).
|
|
38
39
|
|
|
40
|
+
## Generated documentation and themes
|
|
41
|
+
|
|
42
|
+
Version 0.0.13 registers documentation versions 0.0.13, 0.0.12, 0.0.11, 0.0.10 and 0.0.9, newest first, with English, Portuguese and Spanish pages. Existing older folders are preserved. Source content lives in `content/`; defaults and UI labels live in `data/`; edit these sources before regeneration. The published package includes the English PDF guide and the local HTML integration for the externally hosted DOOM player.
|
|
43
|
+
|
|
44
|
+
The scaffold demonstrates parent Markdown destinations with recursive submenus and navigable breadcrumbs, PDF routes/actions, and a page with ordered, repeated Markdown/HTML/video/audio/PDF blocks. Route titles and descriptions have independent placement settings. Focus mode provides source actions and eight document/section navigation controls; browser narration is configured separately. See the generated configuration, content-blocks, focus, accessibility and HTML/PDF guides for complete examples.
|
|
45
|
+
|
|
46
|
+
`gitpagedocs --layoutconfig` ships all 124 themes: 64 original themes, 20 standalone animated presets and 20 additional dark/light parallax pairs. New presets originate in `gitpagelayouts/v2/` and are compiled into package-local data by `pnpm run layouts:sync`; a standalone CLI installation does not need the source repository to emit them. Customize backgrounds through `site.backgroundEffects`, including global/per-theme settings, colors, density, speed and parallax. The master switch disables backgrounds; `overrides.accessibility.showPauseButton: false` hides only the pause control.
|
|
47
|
+
|
|
48
|
+
`site.icons.VersionSelector` and `BackgroundAnimationPause`/`BackgroundAnimationResume` use the same `reactIcon`, `tag`, `size`, `colorDark` and `colorLight` contract as other controls. Pause/resume appears in the navigation menu beside its lock; a manual pause persists across theme and menu changes. `reactIcon: false` selects localized text independently for each control.
|
|
49
|
+
|
|
50
|
+
The [MCP reference](../mcp/README.md) documents installation, client configuration, all 20 tools and seven resources. MCP runs over stdio and reads provider credentials from its environment; it does not automatically unlock the CLI vault.
|
|
51
|
+
|
|
52
|
+
## Packaging and release
|
|
53
|
+
|
|
54
|
+
Root and frontend workspaces are private. The public packages are `@gitpagedocs/tools`, `@gitpagedocs/mcp` and `@gitpagedocs/cli`; their versions, internal ranges and lockfile must agree. The npm workflow checks a new CLI version, installs with a frozen lockfile, runs typecheck and contract self-tests, then publishes the workspaces. GitHub Pages builds the viewer in its separate workflow. Neither workflow creates GitHub release notes or tags automatically.
|
|
55
|
+
|
|
56
|
+
The package allowlist includes its source, templates, data and assets. `prebuilt/` is optional and is not created by the npm workflow. The config-only command generates repository data without starting a server. Run the full project checks and inspect package contents before publication; verify the published package and deployed site afterward.
|
|
57
|
+
|
|
39
58
|
# CLI Architecture (Clean Architecture + SOLID)
|
|
40
59
|
|
|
41
60
|
## Layer Overview
|
|
@@ -141,7 +160,7 @@ npx @gitpagedocs/cli ai
|
|
|
141
160
|
|
|
142
161
|
### What it does
|
|
143
162
|
|
|
144
|
-
- asks provider (
|
|
163
|
+
- asks for a provider from the shared catalog (14 providers, including OpenAI, Anthropic, Gemini and Ollama)
|
|
145
164
|
- asks API key or Ollama URL
|
|
146
165
|
- asks paths to scan (supports one or many paths, including other repositories)
|
|
147
166
|
- generates documentation in `pt`, `en`, `es` **in the gitpagedocs pattern**
|
|
@@ -169,21 +188,22 @@ permissions on POSIX systems:
|
|
|
169
188
|
- Linux: `$XDG_CONFIG_HOME/gitpagedocs/.gitpagedocsconfig` (or `~/.config/gitpagedocs/.gitpagedocsconfig`)
|
|
170
189
|
|
|
171
190
|
Set `GITPAGEDOCS_CONFIG_DIR` to override the directory; delete the stored file,
|
|
172
|
-
the vault and their credentials with `gitpagedocs config clear`.
|
|
173
|
-
|
|
191
|
+
the vault and their credentials with `gitpagedocs config clear`. This example describes
|
|
192
|
+
a saved configuration whose key already exists in the encrypted vault. Edit its non-secret
|
|
193
|
+
settings and then run `npx @gitpagedocs/cli ai`. For a new installation, run the interactive
|
|
194
|
+
setup first; if no key exists, decline reuse of the configuration and enter the credentials.
|
|
174
195
|
|
|
175
196
|
```json
|
|
176
197
|
{
|
|
177
198
|
"version": 1,
|
|
178
199
|
"ai": {
|
|
179
200
|
"provider": "openai",
|
|
180
|
-
"model": "gpt-4o-mini",
|
|
181
201
|
"apiKeyEncrypted": true,
|
|
182
202
|
"paths": ["src", "cli", "../another-repo/src"],
|
|
183
203
|
"languages": ["pt", "en", "es"],
|
|
184
204
|
"outputDir": "gitpagedocs/docs",
|
|
185
205
|
"filePrefix": "ai-generated",
|
|
186
|
-
"contextPrompt": "
|
|
206
|
+
"contextPrompt": "Write clear technical documentation for this project."
|
|
187
207
|
}
|
|
188
208
|
}
|
|
189
209
|
```
|
|
@@ -200,7 +220,7 @@ derived from your password with PBKDF2-HMAC-SHA-256, 210k iterations) and the co
|
|
|
200
220
|
- `GITPAGEDOCS_VAULT_PASSWORD` supplies the password without a prompt (CI, pipes, no TTY);
|
|
201
221
|
on a first run it initializes the vault, otherwise it must match the existing one.
|
|
202
222
|
- A plaintext `"apiKey"` written by 0.0.1 is sealed into the vault and removed from the file
|
|
203
|
-
|
|
223
|
+
when `ai` or `chat` reuses that configuration and unlocks it with the vault password.
|
|
204
224
|
- If you hand-write the file, leave the key out: enter it in the `gitpagedocs ai` prompt (it is
|
|
205
225
|
sealed on save). `gitpagedocs chat` can also read the provider's environment variable
|
|
206
226
|
(`gitpagedocs provider <id>` lists it) when no key is stored.
|
|
@@ -14,7 +14,7 @@ import { GITPAGEDOCS_DOC_SYSTEM_PROMPT } from "../config";
|
|
|
14
14
|
import { parseAiPages, type AiDocPage } from "./docs-pattern";
|
|
15
15
|
import { writeVersionDocs } from "../infrastructure/version-docs-writer";
|
|
16
16
|
// @ts-expect-error .mjs runtime module is type-less in this package.
|
|
17
|
-
import {
|
|
17
|
+
import { PACKAGE_VERSION } from "../../contracts/doc-versions.mjs";
|
|
18
18
|
|
|
19
19
|
const LANGUAGE_TO_LABEL: Record<string, string> = {
|
|
20
20
|
pt: "Portuguese",
|
|
@@ -122,7 +122,7 @@ export async function executeAiRunPlan(
|
|
|
122
122
|
}
|
|
123
123
|
|
|
124
124
|
// Wire the AI pages into the latest documentation version (gitpagedocs pattern).
|
|
125
|
-
const versionId =
|
|
125
|
+
const versionId = PACKAGE_VERSION as string;
|
|
126
126
|
const result = await writeVersionDocs({ cwd, versionId, pagesByLang });
|
|
127
127
|
|
|
128
128
|
return {
|
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
import { PACKAGE_VERSION } from "../contracts/doc-versions.mjs";
|
|
4
4
|
import { THEME_COLORS } from "../data/theme-colors.mjs";
|
|
5
|
+
import { ANIMATED_BACKGROUNDS } from "../data/animated-layouts.mjs";
|
|
5
6
|
|
|
6
7
|
/** `#RRGGBB` (or `#RGB`) to `rgba(r, g, b, alpha)` for palette-derived glows and borders. */
|
|
7
8
|
function rgba(hex, alpha) {
|
|
@@ -14,6 +15,7 @@ function rgba(hex, alpha) {
|
|
|
14
15
|
export function createThemeTemplate(layout, themeColors = THEME_COLORS) {
|
|
15
16
|
const colors = themeColors[layout.id] ?? themeColors.default;
|
|
16
17
|
const dark = layout.mode === "dark";
|
|
18
|
+
const background = ANIMATED_BACKGROUNDS[layout.id];
|
|
17
19
|
return {
|
|
18
20
|
id: layout.id,
|
|
19
21
|
name: layout.name,
|
|
@@ -82,5 +84,6 @@ export function createThemeTemplate(layout, themeColors = THEME_COLORS) {
|
|
|
82
84
|
enableGlow: dark,
|
|
83
85
|
transitionDuration: "0.22s",
|
|
84
86
|
},
|
|
87
|
+
...(background ? { backgroundEffects: structuredClone(background) } : {}),
|
|
85
88
|
};
|
|
86
89
|
}
|
|
@@ -43,6 +43,7 @@ export const RECIPE_ROOT_JSON = JSON.stringify({
|
|
|
43
43
|
defaults: { reactIcon: true, size: "22px", colorDark: "currentColor", colorLight: "currentColor" },
|
|
44
44
|
LanguageSelector: { tag: "SiGoogletranslate" },
|
|
45
45
|
ThemeSelector: { tag: "LuPencil" },
|
|
46
|
+
VersionSelector: { tag: "LuGitBranch" },
|
|
46
47
|
FocusMode: { tag: "LuBookOpen" },
|
|
47
48
|
QuickNavigation: { tag: "LuSearch" },
|
|
48
49
|
PdfDownload: { tag: "LuDownload" },
|
package/content/docs-en.mjs
CHANGED
|
@@ -4,6 +4,7 @@ import { operationsEn } from "./operations-en.mjs";
|
|
|
4
4
|
import { overviewsEn } from "./overviews-en.mjs";
|
|
5
5
|
import { CONTENT_BLOCKS_DOCS } from "./content-blocks.mjs";
|
|
6
6
|
import { PARENT_MENU_JSON } from "./configuration-examples.mjs";
|
|
7
|
+
import { THEME_BACKGROUND_DOCS } from "./theme-backgrounds.mjs";
|
|
7
8
|
|
|
8
9
|
export const docsEn = {
|
|
9
10
|
...practicalEn,
|
|
@@ -43,7 +44,7 @@ PDF actions use icons by default. Configure \`site.icons.PdfDownload\` (\`LuDown
|
|
|
43
44
|
|
|
44
45
|
## Route and menu example
|
|
45
46
|
|
|
46
|
-
In \`gitpagedocs/docs/versions/0.0.
|
|
47
|
+
In \`gitpagedocs/docs/versions/0.0.13/config.json\`, keep route and menu arrays at the top level:
|
|
47
48
|
|
|
48
49
|
\`\`\`json
|
|
49
50
|
{
|
|
@@ -52,9 +53,9 @@ In \`gitpagedocs/docs/versions/0.0.11/config.json\`, keep route and menu arrays
|
|
|
52
53
|
"title": { "en": "Project guide (English)", "pt": "Guia do projeto (inglês)", "es": "Guía del proyecto (inglés)" },
|
|
53
54
|
"pdf": {
|
|
54
55
|
"pathPdf": {
|
|
55
|
-
"en": "gitpagedocs/docs/versions/0.0.
|
|
56
|
-
"pt": "gitpagedocs/docs/versions/0.0.
|
|
57
|
-
"es": "gitpagedocs/docs/versions/0.0.
|
|
56
|
+
"en": "gitpagedocs/docs/versions/0.0.13/en/gitpagedocs-project-guide.pdf",
|
|
57
|
+
"pt": "gitpagedocs/docs/versions/0.0.13/en/gitpagedocs-project-guide.pdf",
|
|
58
|
+
"es": "gitpagedocs/docs/versions/0.0.13/en/gitpagedocs-project-guide.pdf"
|
|
58
59
|
},
|
|
59
60
|
"previewEnabled": true,
|
|
60
61
|
"downloadEnabled": true,
|
|
@@ -212,7 +213,7 @@ Git Page Docs is a **pnpm + turborepo monorepo** that turns a repository's \`git
|
|
|
212
213
|
- 14-provider AI system (OpenAI, Anthropic, Gemini, Ollama, Mistral, DeepSeek, Cohere, Groq, xAI, and more) with streaming
|
|
213
214
|
- AI API keys stored **encrypted at rest** (AES-256-GCM) behind a local password gate — never plaintext
|
|
214
215
|
- In-docs **AI chat drawer** plus a dedicated **\`/ai\` console**
|
|
215
|
-
-
|
|
216
|
+
- 124-theme layout system (dark and light variants); local and GitHub Pages execution modes
|
|
216
217
|
`,
|
|
217
218
|
functionalities: `# Functionalities
|
|
218
219
|
|
|
@@ -419,6 +420,16 @@ Important keys:
|
|
|
419
420
|
- \`ThemeModeDefault\`
|
|
420
421
|
- \`ProjectLink\`
|
|
421
422
|
|
|
423
|
+
## Back to top on long pages
|
|
424
|
+
|
|
425
|
+
The back-to-top arrow on documentation pages and \`/introduction-guide\` is controlled by \`site.backToTop\` in \`gitpagedocs/config.json\`:
|
|
426
|
+
|
|
427
|
+
\`\`\`json
|
|
428
|
+
{ "site": { "backToTop": { "enabled": true, "minPageHeightViewports": 3 } } }
|
|
429
|
+
\`\`\`
|
|
430
|
+
|
|
431
|
+
The default enables the arrow only on a scrollable page whose total height is at least three viewport heights. Set \`enabled: false\` to hide it. \`minPageHeightViewports\` accepts a finite number greater than \`1\`; omitted or invalid values use \`3\`. For example, \`4\` requires a page at least four viewport heights tall. The threshold measures total page height, not distance already scrolled. The same setting controls documentation pages and the introduction guide.
|
|
432
|
+
|
|
422
433
|
## Layout source keys
|
|
423
434
|
|
|
424
435
|
- \`layoutsConfigPathOficial\`
|
|
@@ -434,7 +445,7 @@ Behavior:
|
|
|
434
445
|
|
|
435
446
|
## Language, theme, focus, quick navigation, PDF and document controls
|
|
436
447
|
|
|
437
|
-
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
|
|
448
|
+
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 nine controls use React Icons by default:
|
|
438
449
|
|
|
439
450
|
\`\`\`json
|
|
440
451
|
{
|
|
@@ -448,6 +459,10 @@ In \`gitpagedocs/config.json\`, these \`site.icons\` entries configure the langu
|
|
|
448
459
|
"reactIcon": true, "tag": "LuPencil", "size": "22px",
|
|
449
460
|
"colorDark": "currentColor", "colorLight": "currentColor"
|
|
450
461
|
},
|
|
462
|
+
"VersionSelector": {
|
|
463
|
+
"reactIcon": true, "tag": "LuGitBranch", "size": "22px",
|
|
464
|
+
"colorDark": "currentColor", "colorLight": "currentColor"
|
|
465
|
+
},
|
|
451
466
|
"FocusMode": {
|
|
452
467
|
"reactIcon": true, "tag": "LuBookOpen", "size": "22px",
|
|
453
468
|
"colorDark": "currentColor", "colorLight": "currentColor"
|
|
@@ -483,6 +498,8 @@ Compact configs may move shared values into \`site.icons.defaults\`; omitted fie
|
|
|
483
498
|
|
|
484
499
|
## \`VersionControl\` section
|
|
485
500
|
|
|
501
|
+
\`site.icons.VersionSelector\` uses \`LuGitBranch\` by default. Set \`reactIcon: false\` to display the selected version as text; \`true\` displays its icon. Customize the same \`tag\`, \`size\`, \`colorDark\` and \`colorLight\` fields. The selector appears only when more than one documentation version is available, retains the localized accessible name of the selector and shows the selected version in its tooltip.
|
|
502
|
+
|
|
486
503
|
\`VersionControl.versions\` defines:
|
|
487
504
|
|
|
488
505
|
- \`id\`
|
|
@@ -699,6 +716,8 @@ Select an installed theme through the theme selector or configure \`site.ThemeDe
|
|
|
699
716
|
For your own repository, run the CLI with \`--layoutconfig\`, then edit the generated template and keep its ID consistent with \`layoutsConfig.json\`. A route's content and \`site.icons\` remain independent of the theme catalog. Use \`currentColor\` for icons that should inherit the active text color, or configure separate dark/light colors with sufficient contrast.
|
|
700
717
|
|
|
701
718
|
When contributing to Git Page Docs itself, the authoring source is \`gitpagelayouts/v2/base.json\` plus \`gitpagelayouts/v2/layouts/<id>.json\`. Run \`pnpm layouts:sync\` to regenerate templates and documentation. Direct edits to generated templates can be overwritten by that synchronization.
|
|
719
|
+
|
|
720
|
+
${THEME_BACKGROUND_DOCS.en}
|
|
702
721
|
`,
|
|
703
722
|
mcp: `# MCP server
|
|
704
723
|
|
|
@@ -759,7 +778,7 @@ Select a provider using \`configure_ai_provider\` or \`.gitpagedocs-mcp.json\` a
|
|
|
759
778
|
| \`fireworks\` | \`FIREWORKS_API_KEY\` |
|
|
760
779
|
| \`perplexity\` | \`PERPLEXITY_API_KEY\` |
|
|
761
780
|
|
|
762
|
-
|
|
781
|
+
When the saved selection is absent, unreadable or invalid JSON, the default provider is OpenAI. An unknown provider ID in readable JSON produces an explicit error instead of selecting another provider. Ollama does not require an API key; its local service and chosen model must be available. \`OLLAMA_BASE_URL\` is optional. Azure's base URL is the complete chat-operation URL, including deployment and API-version query when required. Model listings are the bundled catalog, not a live availability check.
|
|
763
782
|
|
|
764
783
|
## Tool reference
|
|
765
784
|
|
|
@@ -815,7 +834,7 @@ The generation step sends selected project content to the configured provider.
|
|
|
815
834
|
|
|
816
835
|
- File reads: up to 512,000 bytes. Listing: up to 2,000 entries; gathered project trees: 400 entries.
|
|
817
836
|
- Search: up to 5,000 entries, 200 matches, 240 characters per matching line.
|
|
818
|
-
- Documentation gathering: first 40 Markdown files among up to 2,000 entries; files over 40,000 bytes are skipped.
|
|
837
|
+
- Documentation gathering: first 40 Markdown files among up to 2,000 entries; files over 40,000 bytes are skipped. Gathered file and Markdown context is limited to 24,000 characters. This is not a global prompt limit: tree/package context, an existing document and a caller-supplied question can add content according to the selected tool.
|
|
819
838
|
- Listing skips build/dependency directories such as \`node_modules\`, \`.git\`, \`.next\`, \`out\`, \`dist\`, \`prebuilt\`, \`.turbo\` and \`coverage\`. It does not interpret \`.gitignore\`; files such as \`.env\` are not automatically excluded. Run only in a trusted project and select the content to expose.
|
|
820
839
|
- Path checks use lexical containment; do not treat the process as an operating-system sandbox or assume symlink/junction isolation. Loading \`project://config\` can import JavaScript/TypeScript configuration.
|
|
821
840
|
- Tool failures include \`isError: true\`. Missing resources return \`Unavailable: ...\`. Check the client's stderr log for startup errors; stdout is reserved for JSON-RPC.
|
|
@@ -1049,7 +1068,7 @@ The download keeps the Markdown basename from the route's localized \`path\`; if
|
|
|
1049
1068
|
|
|
1050
1069
|
The dialog has an accessible name, keyboard focus management and a close control. Use Tab to move through controls and Escape to close it. Keep icon-only controls accessible by retaining their translated names. Closing the dialog returns to the documentation view.
|
|
1051
1070
|
|
|
1052
|
-
Narration is configured separately in Accessibility. Changing the
|
|
1071
|
+
Narration is configured separately in Accessibility. In focus mode, it reads only the section currently displayed. Changing the section, document or language, or entering or leaving focus mode, stops the previous speech; the next reading starts from the visible content. Voice, speed and volume preferences are retained. With \`sectionNavigationEnabled: false\`, the entire document is visible and available for narration. Copy/download still includes the complete original source.
|
|
1053
1072
|
`,
|
|
1054
1073
|
accessibility: `# Accessibility and narration
|
|
1055
1074
|
|
|
@@ -1090,7 +1109,9 @@ Merge the following settings into \`gitpagedocs/config.json\`:
|
|
|
1090
1109
|
|
|
1091
1110
|
Narration starts only after your action; there is no autoplay. Automatic voice selection follows the document language, while an explicit voice choice uses that voice's language. Narration does not translate the document.
|
|
1092
1111
|
|
|
1093
|
-
The speech content is readable text extracted from the rendered Markdown. Scripts, styles, SVG content and elements marked hidden for assistive technology are excluded. Long
|
|
1112
|
+
The speech content is readable text extracted from the rendered Markdown. Scripts, styles, SVG content and elements marked hidden for assistive technology are excluded. Long visible content is read completely in successive blocks. Changing the document or language, disabling narration or leaving the page cancels the previous speech.
|
|
1113
|
+
|
|
1114
|
+
In focus mode, narration uses only the displayed section. Changing sections or documents, or entering or leaving focus mode, stops the previous reading. Start again to read the newly visible content. With \`site.focusMode.sectionNavigationEnabled: false\`, the whole document remains visible and narratable. These transitions preserve the selected voice, speed and volume.
|
|
1094
1115
|
|
|
1095
1116
|
The normal view and focus mode share voice, speed and volume preferences while the page remains mounted. These preferences are not stored across reloads. Non-numeric speed or volume settings use \`1\`; numeric settings outside the supported ranges are clamped to their nearest limit.
|
|
1096
1117
|
|
|
@@ -1142,7 +1163,7 @@ Because GitHub Pages build mode enables repository-search home and static-export
|
|
|
1142
1163
|
|
|
1143
1164
|
## Why does an icon still show text?
|
|
1144
1165
|
|
|
1145
|
-
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.
|
|
1166
|
+
Set \`site.icons.<Control>.reactIcon\` to the boolean \`true\`, with an exact React Icons export name in \`tag\`. LanguageSelector, ThemeSelector, VersionSelector, 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.
|
|
1146
1167
|
|
|
1147
1168
|
## Why do menu children or breadcrumbs differ?
|
|
1148
1169
|
|
package/content/docs-es.mjs
CHANGED
|
@@ -3,6 +3,7 @@ import { operationsEs } from "./operations-es.mjs";
|
|
|
3
3
|
import { overviewsEs } from "./overviews-es.mjs";
|
|
4
4
|
import { CONTENT_BLOCKS_DOCS } from "./content-blocks.mjs";
|
|
5
5
|
import { PARENT_MENU_JSON } from "./configuration-examples.mjs";
|
|
6
|
+
import { THEME_BACKGROUND_DOCS } from "./theme-backgrounds.mjs";
|
|
6
7
|
|
|
7
8
|
export const docsEs = {
|
|
8
9
|
...practicalEs,
|
|
@@ -42,7 +43,7 @@ Las acciones PDF usan iconos por defecto. Configura \`site.icons.PdfDownload\` (
|
|
|
42
43
|
|
|
43
44
|
## Ejemplo de ruta y menú
|
|
44
45
|
|
|
45
|
-
En \`gitpagedocs/docs/versions/0.0.
|
|
46
|
+
En \`gitpagedocs/docs/versions/0.0.13/config.json\`, conserva las listas de rutas y menús en el nivel principal:
|
|
46
47
|
|
|
47
48
|
\`\`\`json
|
|
48
49
|
{
|
|
@@ -51,9 +52,9 @@ En \`gitpagedocs/docs/versions/0.0.11/config.json\`, conserva las listas de ruta
|
|
|
51
52
|
"title": { "en": "Project guide (English)", "pt": "Guia do projeto (inglês)", "es": "Guía del proyecto (inglés)" },
|
|
52
53
|
"pdf": {
|
|
53
54
|
"pathPdf": {
|
|
54
|
-
"en": "gitpagedocs/docs/versions/0.0.
|
|
55
|
-
"pt": "gitpagedocs/docs/versions/0.0.
|
|
56
|
-
"es": "gitpagedocs/docs/versions/0.0.
|
|
55
|
+
"en": "gitpagedocs/docs/versions/0.0.13/en/gitpagedocs-project-guide.pdf",
|
|
56
|
+
"pt": "gitpagedocs/docs/versions/0.0.13/en/gitpagedocs-project-guide.pdf",
|
|
57
|
+
"es": "gitpagedocs/docs/versions/0.0.13/en/gitpagedocs-project-guide.pdf"
|
|
57
58
|
},
|
|
58
59
|
"previewEnabled": true,
|
|
59
60
|
"downloadEnabled": true,
|
|
@@ -211,7 +212,7 @@ Git Page Docs es un monorepo pnpm + turborepo que convierte la carpeta \`gitpage
|
|
|
211
212
|
- Sistema de IA con 14 proveedores (OpenAI, Anthropic, Gemini, Ollama, Mistral, DeepSeek, Cohere, Groq, xAI y más) con streaming
|
|
212
213
|
- Claves de IA **cifradas en reposo** (AES-256-GCM) detrás de una contraseña local — nunca en texto plano
|
|
213
214
|
- **Panel de chat de IA** en los docs + una **consola \`/ai\`** dedicada
|
|
214
|
-
- Sistema de
|
|
215
|
+
- Sistema de 124 temas (variantes oscuras y claras); ejecución local y en GitHub Pages
|
|
215
216
|
`,
|
|
216
217
|
functionalities: `# Funcionalidades
|
|
217
218
|
|
|
@@ -313,9 +314,19 @@ Claves principales:
|
|
|
313
314
|
- \`layoutsConfigPath\`: fallback remoto de layouts
|
|
314
315
|
- \`rendering\`: URL canónica publicada
|
|
315
316
|
|
|
317
|
+
## Volver arriba en páginas largas
|
|
318
|
+
|
|
319
|
+
La flecha para volver arriba en las páginas de documentación y en \`/introduction-guide\` se controla mediante \`site.backToTop\` en \`gitpagedocs/config.json\`:
|
|
320
|
+
|
|
321
|
+
\`\`\`json
|
|
322
|
+
{ "site": { "backToTop": { "enabled": true, "minPageHeightViewports": 3 } } }
|
|
323
|
+
\`\`\`
|
|
324
|
+
|
|
325
|
+
Por defecto, la flecha está activada solo en una página desplazable cuya altura total sea al menos tres veces la altura del área visible del navegador. Usa \`enabled: false\` para ocultarla. \`minPageHeightViewports\` acepta un número finito mayor que \`1\`; los valores ausentes o no válidos usan \`3\`. Por ejemplo, \`4\` exige una página de al menos cuatro alturas del área visible. El umbral mide la altura total de la página, no la distancia ya recorrida. La misma configuración controla las páginas de documentación y la guía de introducción.
|
|
326
|
+
|
|
316
327
|
## Controles de idioma, tema, foco, navegación rápida, PDF y documentos
|
|
317
328
|
|
|
318
|
-
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
|
|
329
|
+
En \`gitpagedocs/config.json\`, estas entradas de \`site.icons\` configuran idioma, tema, versión, foco, navegación Ctrl+K, acciones PDF y navegación al pie de los documentos. Los nueve controles utilizan React Icons por defecto:
|
|
319
330
|
|
|
320
331
|
\`\`\`json
|
|
321
332
|
{
|
|
@@ -333,6 +344,10 @@ En \`gitpagedocs/config.json\`, estas entradas de \`site.icons\` configuran idio
|
|
|
333
344
|
"reactIcon": true, "tag": "LuBookOpen", "size": "22px",
|
|
334
345
|
"colorDark": "currentColor", "colorLight": "currentColor"
|
|
335
346
|
},
|
|
347
|
+
"VersionSelector": {
|
|
348
|
+
"reactIcon": true, "tag": "LuGitBranch", "size": "22px",
|
|
349
|
+
"colorDark": "currentColor", "colorLight": "currentColor"
|
|
350
|
+
},
|
|
336
351
|
"QuickNavigation": {
|
|
337
352
|
"reactIcon": true, "tag": "LuSearch", "size": "22px",
|
|
338
353
|
"colorDark": "currentColor", "colorLight": "currentColor"
|
|
@@ -364,6 +379,8 @@ Las configuraciones compactas pueden mover valores comunes a \`site.icons.defaul
|
|
|
364
379
|
|
|
365
380
|
## Sección \`VersionControl\`
|
|
366
381
|
|
|
382
|
+
\`site.icons.VersionSelector\` utiliza \`LuGitBranch\` por defecto. Define \`reactIcon: false\` para mostrar el texto de la versión seleccionada; \`true\` muestra el icono. Personaliza los mismos campos \`tag\`, \`size\`, \`colorDark\` y \`colorLight\`. El selector aparece solo cuando hay más de una versión de documentación; conserva el nombre accesible localizado del selector y muestra la versión seleccionada en el tooltip.
|
|
383
|
+
|
|
367
384
|
\`VersionControl.versions\` define:
|
|
368
385
|
|
|
369
386
|
- \`id\`: identificador de versión
|
|
@@ -639,7 +656,7 @@ Cada template normalmente incluye:
|
|
|
639
656
|
- toggle light/dark resuelve tema pareado por referencia
|
|
640
657
|
- variables CSS se generan desde tokens del template
|
|
641
658
|
|
|
642
|
-
## Buenas
|
|
659
|
+
## Buenas prácticas
|
|
643
660
|
|
|
644
661
|
- mantener contraste accesible
|
|
645
662
|
- mantener escala consistente de espacios y bordes
|
|
@@ -652,6 +669,8 @@ Elige un tema mediante el selector o configura \`site.ThemeDefault\` con su ID e
|
|
|
652
669
|
En tu repositorio, ejecuta la CLI con \`--layoutconfig\`, edita la plantilla generada y conserva el ID coherente con \`layoutsConfig.json\`. El contenido de ruta y \`site.icons\` son independientes del catálogo de temas. Usa \`currentColor\` para iconos que heredan el color de texto o configura colores claros/oscuros con contraste suficiente.
|
|
653
670
|
|
|
654
671
|
Al contribuir en Git Page Docs, la fuente es \`gitpagelayouts/v2/base.json\` junto con \`gitpagelayouts/v2/layouts/<id>.json\`. Ejecuta \`pnpm layouts:sync\` para generar plantillas y documentación. La sincronización puede sobrescribir las ediciones directas de plantillas generadas.
|
|
672
|
+
|
|
673
|
+
${THEME_BACKGROUND_DOCS.es}
|
|
655
674
|
`,
|
|
656
675
|
mcp: `# Servidor MCP
|
|
657
676
|
|
|
@@ -712,7 +731,7 @@ Selecciona el proveedor con \`configure_ai_provider\` o con \`.gitpagedocs-mcp.j
|
|
|
712
731
|
| \`fireworks\` | \`FIREWORKS_API_KEY\` |
|
|
713
732
|
| \`perplexity\` | \`PERPLEXITY_API_KEY\` |
|
|
714
733
|
|
|
715
|
-
|
|
734
|
+
Cuando la selección guardada está ausente, no se puede leer o contiene JSON inválido, el proveedor predeterminado es OpenAI. Un ID de proveedor desconocido en JSON legible produce un error explícito sin seleccionar otro proveedor. Ollama no requiere clave de API; el servicio local y el modelo elegido deben estar disponibles. \`OLLAMA_BASE_URL\` es opcional. La URL base de Azure es la URL completa de la operación de chat, incluido deployment y versión de API cuando sean necesarios. La lista de modelos es un catálogo distribuido, no una comprobación en tiempo real.
|
|
716
735
|
|
|
717
736
|
## Referencia de tools
|
|
718
737
|
|
|
@@ -768,7 +787,7 @@ La generación envía el contenido seleccionado del proyecto al proveedor config
|
|
|
768
787
|
|
|
769
788
|
- Lectura de archivos: hasta 512.000 bytes. Listado: hasta 2.000 entradas; árboles recopilados del proyecto: 400 entradas.
|
|
770
789
|
- Búsqueda: hasta 5.000 entradas, 200 resultados y 240 caracteres por línea encontrada.
|
|
771
|
-
- Recopilación de documentación: primeros 40 archivos Markdown entre hasta 2.000 entradas; se omiten archivos superiores a 40.000 bytes. El contexto
|
|
790
|
+
- Recopilación de documentación: primeros 40 archivos Markdown entre hasta 2.000 entradas; se omiten archivos superiores a 40.000 bytes. El contexto recopilado de archivos y Markdown se limita a 24.000 caracteres. No es un límite global del prompt: árbol/paquete, documento existente y pregunta proporcionada pueden añadir contenido según la tool seleccionada.
|
|
772
791
|
- El listado omite carpetas de dependencias/build como \`node_modules\`, \`.git\`, \`.next\`, \`out\`, \`dist\`, \`prebuilt\`, \`.turbo\` y \`coverage\`. No interpreta \`.gitignore\`; archivos como \`.env\` no se excluyen automáticamente. Ejecuta solo en proyectos de confianza y selecciona el contenido que se expondrá.
|
|
773
792
|
- La verificación de rutas es léxica; el proceso no es un sandbox del sistema operativo ni garantiza aislamiento de symlinks/junctions. Leer \`project://config\` puede importar configuración JavaScript/TypeScript.
|
|
774
793
|
- Los fallos de tools incluyen \`isError: true\`. Los resources ausentes devuelven \`Unavailable: ...\`. Revisa stderr en el cliente para errores de inicio; stdout está reservado para JSON-RPC.
|
|
@@ -1002,7 +1021,7 @@ La descarga conserva el nombre base Markdown del \`path\` localizado de la ruta;
|
|
|
1002
1021
|
|
|
1003
1022
|
El diálogo tiene nombre accesible, gestión de foco del teclado y control de cierre. Usa Tab para recorrer controles y Escape para cerrar. Los controles de solo icono conservan nombres traducidos accesibles. Cerrar el diálogo vuelve a la documentación.
|
|
1004
1023
|
|
|
1005
|
-
La narración se configura por separado en Accesibilidad. Cambiar de documento o idioma
|
|
1024
|
+
La narración se configura por separado en Accesibilidad. En modo foco, lee solo la sección mostrada. Cambiar de sección, documento o idioma, entrar o salir del modo foco detiene la voz anterior; la próxima lectura empieza desde el contenido visible. Se conservan las preferencias de voz, velocidad y volumen. Con \`sectionNavigationEnabled: false\`, el documento completo queda visible y disponible para narración. Copiar/descargar sigue incluyendo toda la fuente original.
|
|
1006
1025
|
`,
|
|
1007
1026
|
accessibility: `# Accesibilidad y narración
|
|
1008
1027
|
|
|
@@ -1043,7 +1062,9 @@ Combina estas opciones con \`gitpagedocs/config.json\`:
|
|
|
1043
1062
|
|
|
1044
1063
|
La narración empieza solo después de tu acción; no hay reproducción automática. La selección automática de voz sigue el idioma del documento; elegir una voz explícitamente utiliza el idioma de esa voz. La narración no traduce el documento.
|
|
1045
1064
|
|
|
1046
|
-
La voz utiliza texto legible extraído del Markdown renderizado. Se excluyen scripts, estilos, contenido SVG y elementos ocultos para tecnologías de asistencia.
|
|
1065
|
+
La voz utiliza texto legible extraído del Markdown renderizado. Se excluyen scripts, estilos, contenido SVG y elementos ocultos para tecnologías de asistencia. El contenido visible largo se lee completo en bloques sucesivos. Cambiar de documento o idioma, desactivar la narración o salir de la página cancela la voz anterior.
|
|
1066
|
+
|
|
1067
|
+
En modo foco, la narración usa solo la sección mostrada. Cambiar de sección o documento, entrar o salir del modo foco detiene la lectura anterior. Inicia de nuevo para leer el contenido que ahora está visible. Con \`site.focusMode.sectionNavigationEnabled: false\`, el documento completo permanece visible y se puede narrar. Estas transiciones conservan la voz, velocidad y volumen seleccionados.
|
|
1047
1068
|
|
|
1048
1069
|
La vista habitual y el modo foco comparten preferencias de voz, velocidad y volumen mientras la página permanece montada. Las preferencias no se guardan entre recargas. Los valores no numéricos de velocidad o volumen usan \`1\`; los valores numéricos fuera de los rangos admitidos se limitan al extremo más cercano.
|
|
1049
1070
|
|
|
@@ -1095,7 +1116,7 @@ Porque el build de GitHub Pages habilita la página inicial de búsqueda y compo
|
|
|
1095
1116
|
|
|
1096
1117
|
## ¿Por qué el icono sigue mostrando texto?
|
|
1097
1118
|
|
|
1098
|
-
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.
|
|
1119
|
+
Define \`site.icons.<Control>.reactIcon\` como booleano \`true\`, con el nombre exacto exportado por React Icons en \`tag\`. LanguageSelector, ThemeSelector, VersionSelector, 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.
|
|
1099
1120
|
|
|
1100
1121
|
## ¿Por qué los hijos del menú o breadcrumbs son diferentes?
|
|
1101
1122
|
|
package/content/docs-pt.mjs
CHANGED
|
@@ -3,6 +3,7 @@ import { operationsPt } from "./operations-pt.mjs";
|
|
|
3
3
|
import { overviewsPt } from "./overviews-pt.mjs";
|
|
4
4
|
import { CONTENT_BLOCKS_DOCS } from "./content-blocks.mjs";
|
|
5
5
|
import { PARENT_MENU_JSON } from "./configuration-examples.mjs";
|
|
6
|
+
import { THEME_BACKGROUND_DOCS } from "./theme-backgrounds.mjs";
|
|
6
7
|
|
|
7
8
|
export const docsPt = {
|
|
8
9
|
...practicalPt,
|
|
@@ -42,7 +43,7 @@ As ações PDF usam ícones por padrão. Configure \`site.icons.PdfDownload\` (\
|
|
|
42
43
|
|
|
43
44
|
## Exemplo de rota e menu
|
|
44
45
|
|
|
45
|
-
Em \`gitpagedocs/docs/versions/0.0.
|
|
46
|
+
Em \`gitpagedocs/docs/versions/0.0.13/config.json\`, mantenha as listas de rotas e menus no nível principal:
|
|
46
47
|
|
|
47
48
|
\`\`\`json
|
|
48
49
|
{
|
|
@@ -51,9 +52,9 @@ Em \`gitpagedocs/docs/versions/0.0.11/config.json\`, mantenha as listas de rotas
|
|
|
51
52
|
"title": { "en": "Project guide (English)", "pt": "Guia do projeto (inglês)", "es": "Guía del proyecto (inglés)" },
|
|
52
53
|
"pdf": {
|
|
53
54
|
"pathPdf": {
|
|
54
|
-
"en": "gitpagedocs/docs/versions/0.0.
|
|
55
|
-
"pt": "gitpagedocs/docs/versions/0.0.
|
|
56
|
-
"es": "gitpagedocs/docs/versions/0.0.
|
|
55
|
+
"en": "gitpagedocs/docs/versions/0.0.13/en/gitpagedocs-project-guide.pdf",
|
|
56
|
+
"pt": "gitpagedocs/docs/versions/0.0.13/en/gitpagedocs-project-guide.pdf",
|
|
57
|
+
"es": "gitpagedocs/docs/versions/0.0.13/en/gitpagedocs-project-guide.pdf"
|
|
57
58
|
},
|
|
58
59
|
"previewEnabled": true,
|
|
59
60
|
"downloadEnabled": true,
|
|
@@ -211,7 +212,7 @@ Git Page Docs é um monorepo pnpm + turborepo que transforma a pasta \`gitpagedo
|
|
|
211
212
|
- Sistema de IA com 14 provedores (OpenAI, Anthropic, Gemini, Ollama, Mistral, DeepSeek, Cohere, Groq, xAI e mais) com streaming
|
|
212
213
|
- Chaves de IA **criptografadas em repouso** (AES-256-GCM) atras de uma senha local — nunca em texto puro
|
|
213
214
|
- **Drawer de chat de IA** nos docs + um **console \`/ai\`** dedicado
|
|
214
|
-
- Sistema de
|
|
215
|
+
- Sistema de 124 temas (variantes escuras e claras); execução local e no GitHub Pages
|
|
215
216
|
`,
|
|
216
217
|
functionalities: `# Funcionalidades
|
|
217
218
|
|
|
@@ -313,9 +314,19 @@ Principais chaves:
|
|
|
313
314
|
- \`layoutsConfigPath\`: fallback remoto para layouts
|
|
314
315
|
- \`rendering\`: URL canonica publicada
|
|
315
316
|
|
|
317
|
+
## Voltar ao topo em páginas longas
|
|
318
|
+
|
|
319
|
+
A seta de voltar ao topo nas páginas de documentação e em \`/introduction-guide\` é controlada por \`site.backToTop\` em \`gitpagedocs/config.json\`:
|
|
320
|
+
|
|
321
|
+
\`\`\`json
|
|
322
|
+
{ "site": { "backToTop": { "enabled": true, "minPageHeightViewports": 3 } } }
|
|
323
|
+
\`\`\`
|
|
324
|
+
|
|
325
|
+
Por padrão, a seta fica habilitada somente em uma página com rolagem cuja altura total seja pelo menos três vezes a altura da área visível do navegador. Use \`enabled: false\` para ocultá-la. \`minPageHeightViewports\` aceita um número finito maior que \`1\`; valores ausentes ou inválidos usam \`3\`. Por exemplo, \`4\` exige uma página com pelo menos quatro alturas da área visível. O limiar mede a altura total da página, não a distância já percorrida. A mesma configuração controla as páginas de documentação e o guia de introdução.
|
|
326
|
+
|
|
316
327
|
## Controles de idioma, tema, foco, navegação rápida, PDF e documentos
|
|
317
328
|
|
|
318
|
-
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
|
|
329
|
+
Em \`gitpagedocs/config.json\`, estas entradas de \`site.icons\` configuram idioma, tema, versão, foco, navegação Ctrl+K, ações PDF e navegação no rodapé dos documentos. Os nove controles usam React Icons por padrão:
|
|
319
330
|
|
|
320
331
|
\`\`\`json
|
|
321
332
|
{
|
|
@@ -333,6 +344,10 @@ Em \`gitpagedocs/config.json\`, estas entradas de \`site.icons\` configuram idio
|
|
|
333
344
|
"reactIcon": true, "tag": "LuBookOpen", "size": "22px",
|
|
334
345
|
"colorDark": "currentColor", "colorLight": "currentColor"
|
|
335
346
|
},
|
|
347
|
+
"VersionSelector": {
|
|
348
|
+
"reactIcon": true, "tag": "LuGitBranch", "size": "22px",
|
|
349
|
+
"colorDark": "currentColor", "colorLight": "currentColor"
|
|
350
|
+
},
|
|
336
351
|
"QuickNavigation": {
|
|
337
352
|
"reactIcon": true, "tag": "LuSearch", "size": "22px",
|
|
338
353
|
"colorDark": "currentColor", "colorLight": "currentColor"
|
|
@@ -364,6 +379,8 @@ Configs compactos podem mover valores comuns para \`site.icons.defaults\`; campo
|
|
|
364
379
|
|
|
365
380
|
## Seção \`VersionControl\`
|
|
366
381
|
|
|
382
|
+
\`site.icons.VersionSelector\` usa \`LuGitBranch\` por padrão. Defina \`reactIcon: false\` para mostrar o texto da versão selecionada; \`true\` mostra o ícone. Personalize os mesmos campos \`tag\`, \`size\`, \`colorDark\` e \`colorLight\`. O seletor aparece somente quando há mais de uma versão de documentação, preserva o nome acessível localizado do seletor e mostra a versão selecionada no tooltip.
|
|
383
|
+
|
|
367
384
|
\`VersionControl.versions\` define:
|
|
368
385
|
|
|
369
386
|
- \`id\`: identificador da versão
|
|
@@ -624,7 +641,7 @@ Temas são templates JSON mapeados por \`layoutsConfig.json\`.
|
|
|
624
641
|
|
|
625
642
|
## Modelo de template
|
|
626
643
|
|
|
627
|
-
Cada template normalmente
|
|
644
|
+
Cada template normalmente contém:
|
|
628
645
|
|
|
629
646
|
- \`id\`, \`name\`, \`author\`, \`version\`
|
|
630
647
|
- \`mode\` e metadados de par dark/light
|
|
@@ -639,11 +656,11 @@ Cada template normalmente contem:
|
|
|
639
656
|
- toggle light/dark resolve o tema pareado por referência
|
|
640
657
|
- variáveis CSS são geradas dos tokens do template
|
|
641
658
|
|
|
642
|
-
## Boas
|
|
659
|
+
## Boas práticas
|
|
643
660
|
|
|
644
|
-
- mantenha contraste
|
|
645
|
-
- padronize escala de
|
|
646
|
-
-
|
|
661
|
+
- mantenha contraste acessível
|
|
662
|
+
- padronize escala de espaço e borda
|
|
663
|
+
- ofereça variantes dark e light quando possível
|
|
647
664
|
|
|
648
665
|
## Escolher e personalizar
|
|
649
666
|
|
|
@@ -652,6 +669,8 @@ Escolha um tema pelo seletor ou configure \`site.ThemeDefault\` com seu ID exato
|
|
|
652
669
|
No seu repositório, execute a CLI com \`--layoutconfig\`, edite o template gerado e mantenha o ID coerente com \`layoutsConfig.json\`. O conteúdo da rota e \`site.icons\` são independentes do catálogo de temas. Use \`currentColor\` para ícones que herdam a cor do texto ou configure cores claras/escuras com contraste suficiente.
|
|
653
670
|
|
|
654
671
|
Ao contribuir no Git Page Docs, a fonte autoral é \`gitpagelayouts/v2/base.json\` com \`gitpagelayouts/v2/layouts/<id>.json\`. Execute \`pnpm layouts:sync\` para gerar templates e documentação. Edições diretas nos templates gerados podem ser substituídas pela sincronização.
|
|
672
|
+
|
|
673
|
+
${THEME_BACKGROUND_DOCS.pt}
|
|
655
674
|
`,
|
|
656
675
|
mcp: `# Servidor MCP
|
|
657
676
|
|
|
@@ -712,7 +731,7 @@ Selecione o provedor com \`configure_ai_provider\` ou pelo arquivo \`.gitpagedoc
|
|
|
712
731
|
| \`fireworks\` | \`FIREWORKS_API_KEY\` |
|
|
713
732
|
| \`perplexity\` | \`PERPLEXITY_API_KEY\` |
|
|
714
733
|
|
|
715
|
-
|
|
734
|
+
Quando a seleção salva está ausente, ilegível ou contém JSON inválido, o provedor padrão é OpenAI. Um ID de provedor desconhecido em JSON legível gera erro explícito, sem selecionar outro provedor. Ollama não exige chave de API; o serviço local e o modelo escolhido precisam estar disponíveis. \`OLLAMA_BASE_URL\` é opcional. A URL base do Azure é a URL completa da operação de chat, incluindo deployment e versão da API quando exigidos. A lista de modelos é um catálogo distribuído, não uma verificação de disponibilidade em tempo real.
|
|
716
735
|
|
|
717
736
|
## Referência de tools
|
|
718
737
|
|
|
@@ -768,7 +787,7 @@ A etapa de geração envia o conteúdo selecionado do projeto ao provedor config
|
|
|
768
787
|
|
|
769
788
|
- Leitura de arquivos: até 512.000 bytes. Listagem: até 2.000 entradas; árvores coletadas do projeto: 400 entradas.
|
|
770
789
|
- Busca: até 5.000 entradas, 200 resultados e 240 caracteres por linha encontrada.
|
|
771
|
-
- Coleta de documentação: primeiros 40 arquivos Markdown entre até 2.000 entradas; arquivos acima de 40.000 bytes são ignorados. O contexto
|
|
790
|
+
- Coleta de documentação: primeiros 40 arquivos Markdown entre até 2.000 entradas; arquivos acima de 40.000 bytes são ignorados. O contexto coletado de arquivos e Markdown é limitado a 24.000 caracteres. Isso não é um limite global do prompt: árvore/pacote, documento existente e pergunta fornecida podem acrescentar conteúdo conforme a tool escolhida.
|
|
772
791
|
- A listagem ignora pastas de dependências/build como \`node_modules\`, \`.git\`, \`.next\`, \`out\`, \`dist\`, \`prebuilt\`, \`.turbo\` e \`coverage\`. Não interpreta \`.gitignore\`; arquivos como \`.env\` não são excluídos automaticamente. Execute somente em projeto confiável e selecione o conteúdo que será exposto.
|
|
773
792
|
- A verificação de caminhos é lexical; o processo não é um sandbox do sistema operacional nem garante isolamento de symlinks/junctions. Ler \`project://config\` pode importar configuração JavaScript/TypeScript.
|
|
774
793
|
- Falhas de tools incluem \`isError: true\`. Resources ausentes retornam \`Unavailable: ...\`. Consulte stderr no cliente para falhas de inicialização; stdout é reservado para JSON-RPC.
|
|
@@ -1002,7 +1021,7 @@ O download conserva o nome-base Markdown do \`path\` localizado da rota; quando
|
|
|
1002
1021
|
|
|
1003
1022
|
O diálogo possui nome acessível, gerenciamento de foco do teclado e controle de fechar. Use Tab para percorrer controles e Escape para fechar. Controles só com ícone continuam com seus nomes traduzidos acessíveis. Fechar o diálogo retorna à documentação.
|
|
1004
1023
|
|
|
1005
|
-
A narração é configurada separadamente em Acessibilidade. Trocar documento ou idioma
|
|
1024
|
+
A narração é configurada separadamente em Acessibilidade. No modo foco, lê somente a seção exibida. Trocar seção, documento ou idioma, entrar ou sair do modo foco interrompe a fala anterior; a próxima leitura começa no conteúdo visível. As preferências de voz, velocidade e volume são mantidas. Com \`sectionNavigationEnabled: false\`, o documento inteiro fica visível e disponível para narração. Copiar/baixar continua incluindo a fonte original completa.
|
|
1006
1025
|
`,
|
|
1007
1026
|
accessibility: `# Acessibilidade e narração
|
|
1008
1027
|
|
|
@@ -1043,7 +1062,9 @@ Mescle estas opções em \`gitpagedocs/config.json\`:
|
|
|
1043
1062
|
|
|
1044
1063
|
A narração começa somente após sua ação; não há reprodução automática. A seleção automática de voz acompanha o idioma do documento; escolher uma voz explicitamente utiliza o idioma dessa voz. A narração não traduz o documento.
|
|
1045
1064
|
|
|
1046
|
-
A fala usa texto legível extraído do Markdown renderizado. Scripts, estilos, conteúdo SVG e elementos ocultos para tecnologias assistivas são excluídos.
|
|
1065
|
+
A fala usa texto legível extraído do Markdown renderizado. Scripts, estilos, conteúdo SVG e elementos ocultos para tecnologias assistivas são excluídos. O conteúdo visível longo é lido por inteiro em blocos sucessivos. Trocar documento ou idioma, desabilitar a narração ou sair da página cancela a fala anterior.
|
|
1066
|
+
|
|
1067
|
+
No modo foco, a narração usa somente a seção exibida. Trocar seção ou documento, entrar ou sair do modo foco interrompe a leitura anterior. Inicie novamente para ler o conteúdo que passou a estar visível. Com \`site.focusMode.sectionNavigationEnabled: false\`, o documento inteiro fica visível e pode ser narrado. Essas transições preservam a voz, a velocidade e o volume selecionados.
|
|
1047
1068
|
|
|
1048
1069
|
A visualização comum e o modo foco compartilham preferências de voz, velocidade e volume enquanto a página permanece montada. As preferências não são salvas entre recarregamentos. Valores não numéricos de velocidade ou volume usam \`1\`; valores numéricos fora das faixas suportadas são limitados ao extremo mais próximo.
|
|
1049
1070
|
|
|
@@ -1095,7 +1116,7 @@ Porque o build de GitHub Pages habilita página inicial de busca e comportamento
|
|
|
1095
1116
|
|
|
1096
1117
|
## Por que o ícone ainda mostra texto?
|
|
1097
1118
|
|
|
1098
|
-
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.
|
|
1119
|
+
Defina \`site.icons.<Controle>.reactIcon\` como booleano \`true\`, com o nome exato exportado por React Icons em \`tag\`. LanguageSelector, ThemeSelector, VersionSelector, 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.
|
|
1099
1120
|
|
|
1100
1121
|
## Por que filhos de menus ou breadcrumbs aparecem diferentes?
|
|
1101
1122
|
|
package/content/practical-en.mjs
CHANGED
|
@@ -13,7 +13,7 @@ Add this route to the version configuration's existing \`routes-html\` array. Ke
|
|
|
13
13
|
${HTML_ROUTE_JSON}
|
|
14
14
|
\`\`\`
|
|
15
15
|
|
|
16
|
-
Add a localized item in \`menus-header-html\`. Each \`path-click\` must match its language's route path, such as \`gitpagedocs/docs/versions/0.0.
|
|
16
|
+
Add a localized item in \`menus-header-html\`. Each \`path-click\` must match its language's route path, such as \`gitpagedocs/docs/versions/0.0.13/en/doom.html\`; do not substitute \`page:29\` for this local HTML path. Menu labels do not create routes. HTML uses the same recursive \`submenus\` structure as other menus.
|
|
17
17
|
|
|
18
18
|
## Size, content and external URLs
|
|
19
19
|
|
|
@@ -35,9 +35,9 @@ This guide builds a small multilingual documentation site with two Markdown page
|
|
|
35
35
|
|
|
36
36
|
## 1. Generate and inspect the scaffold
|
|
37
37
|
|
|
38
|
-
The scaffold includes versions 0.0.11 and 0.0.
|
|
38
|
+
The scaffold includes versions 0.0.13, 0.0.12, 0.0.11, 0.0.10 and 0.0.9 in the version selector, newest first. All five contain the current examples; the package version is 0.0.13. Their paths and version badges are generated for the selected documentation version. Older existing version folders are not deleted.
|
|
39
39
|
|
|
40
|
-
Run \`npx --yes @gitpagedocs/cli@0.0.
|
|
40
|
+
Run \`npx --yes @gitpagedocs/cli@0.0.13 --no-interactive --owner YOUR_USER --repo YOUR_REPOSITORY\` in a new project directory. In this source repository, \`node cli/index.mjs\` runs the checked-out version. Generation writes configuration and documentation; it does not start the Next.js viewer.
|
|
41
41
|
|
|
42
42
|
Use the following complete JSON as a minimal root-config example in \`gitpagedocs/config.json\`. For an existing site, merge the relevant fields and preserve its repository identity, deployment settings, themes and other versions.
|
|
43
43
|
|
|
@@ -45,7 +45,7 @@ Use the following complete JSON as a minimal root-config example in \`gitpagedoc
|
|
|
45
45
|
${RECIPE_ROOT_JSON}
|
|
46
46
|
\`\`\`
|
|
47
47
|
|
|
48
|
-
The
|
|
48
|
+
The nine entries inherit the common icon presentation from \`icons.defaults\`. To display text for one action, add \`"reactIcon": false\` to that entry. Do not change a shared default just to alter one button. Existing flat icon fields win over compact fields, so remove or update an old conflicting field deliberately.
|
|
49
49
|
|
|
50
50
|
## 2. Create the version configuration
|
|
51
51
|
|