Skip to content

Commit 6447417

Browse files
committed
chore(release): 0.0.13 - focus narration and accessible navigation
Read the visible focus section and keep narration controls synchronized. Theme native voice selection and add configurable back-to-top navigation to long documentation pages and the introduction guide. Retain documentation versions from 0.0.9 through 0.0.13 and synchronize package versions, generated documentation and configuration baselines.
1 parent eace3c6 commit 6447417

492 files changed

Lines changed: 22650 additions & 965 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎AUDIT.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
This file records the public contracts checked by `tools/smoke/` and the current
66
viewer tests. Supported compatibility starts at version **0.0.1**; legacy 1.1.x
7-
formats are outside the supported baseline. Version 0.0.12 adds capabilities
7+
formats are outside the supported baseline. Version 0.0.13 adds capabilities
88
without removing existing 0.0.x routes, configuration or documentation folders.
99

1010
> Keep the contract checks and this checklist aligned when changing the scaffold.
@@ -43,7 +43,7 @@ Flags include `--build --serve --layoutconfig --layouts-dir --full --push --home
4343
- `gitpagedocs/config.json` contains `site` and `VersionControl`; language bundles hold generated UI strings, while legacy inline strings remain readable.
4444
- `site.languages` in `gitpagedocs/config.json` (`{ "en": true, "pt": true, "es": true }`) + `gitpagedocs/langs/<lang>.json` (`langmenu` + `translations` per language; `cli/contracts/languages.mjs`, `cli/contracts/langs-paths.mjs`).
4545
- `gitpagedocs/icon.svg`.
46-
- Per version in `DOC_VERSIONS` (`cli/contracts/doc-versions.mjs`; currently `0.0.12`, `0.0.11`, `0.0.10`):
46+
- Per version in `DOC_VERSIONS` (`cli/contracts/doc-versions.mjs`; currently `0.0.13`, `0.0.12`, `0.0.11`, `0.0.10`, `0.0.9`, newest first):
4747
`gitpagedocs/docs/versions/<v>/config.json` contains `routes-md`, `routes-html`, `routes-source-viewer`, `routes-video`, `routes-audio`, `routes-pdf` and corresponding `menus-header-*`. `pages[].blocks` adds ordered, repeated MD/HTML/video/audio/PDF references without replacing legacy routes. Localized Markdown and the HTML demo come from `cli/content/`; the included English PDF is copied unchanged.
4848
- The source-viewer route points at the GitHub tree URL (`source-viewer-path`), so no HTML snapshot is generated any more; the byte-stable contract covers `config.json` + `langs/*.json` only.
4949
- Deterministic configuration and language bundles are checked against the approved `baseline.snapshot.json`. Intentional default changes require regeneration, review and baseline refresh; existing user-authored documents are preserved by the normal output policy.

‎CHANGELOG.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,14 @@
33
All notable changes to Git Page Docs are documented here. Versions follow semver and count from the
44
0.0.1 baseline below.
55

6+
## 0.0.13 - 2026-10-18 - reading controls and retained documentation versions
7+
8+
- Narrate only the visible section in focus mode. Stop the previous speech when changing sections or documents and when entering or leaving focus mode, while preserving voice, speed and volume preferences. Disabling section navigation keeps the whole document visible and available for narration.
9+
- Show a back-to-top arrow on long documentation pages and the introduction guide. Configure visibility with `site.backToTop.enabled` and the minimum page height with `site.backToTop.minPageHeightViewports`, which defaults to three viewport heights.
10+
- Apply the active theme to the native voice selector and its options while preserving browser keyboard behavior.
11+
- Register every documentation version from 0.0.9 through 0.0.13 in descending order, with localized configuration and reading guides. Preserve older folders and the existing PDF guide.
12+
- Correct the project overview to describe the current catalog of 124 themes and synchronize the generated documentation in English, Portuguese and Spanish.
13+
614
## 0.0.12 - 2026-10-18 - animated themes and configurable playback controls
715

816
- Expand the theme catalog from 64 to 124 entries with 20 standalone animated presets and 20 additional parallax families, each with dark and light variants. Preserve the existing themes and native light/dark pairing.

‎CONTRIBUTING.md‎

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ This is a pnpm + turbo monorepo: `frontend/` (Next.js viewer), `cli/` (the publi
3535
### User references
3636

3737
The generated documentation includes 32 Markdown pages per language: focused references plus complete configuration recipes, migration/compatibility, troubleshooting, contributing/testing and HTML-container guides. All pages are available in English, Portuguese and Spanish; Markdown filenames stay in English while titles and content preserve UTF-8 accents and special characters.
38-
The scaffold registers documentation versions 0.0.12, 0.0.11 and 0.0.10 with the current examples; the npm package version is 0.0.12. Paths and version badges match each generated documentation version. Existing older version folders are preserved.
38+
The scaffold registers documentation versions 0.0.13, 0.0.12, 0.0.11, 0.0.10 and 0.0.9 in descending order with the current examples; the npm package version is 0.0.13. Paths and version badges match each generated documentation version. Existing older version folders are preserved.
3939

4040
The scaffold has real nested sections: Guides → Configure your site / Read and explore / Automate and integrate → documents, plus Operations and development and Git/GitHub groups. Getting Started and Project overview remain the first destinations. Every parent section has its own localized Markdown overview: click its title to read it, or use the separate arrow to expand children. Breadcrumb ancestors such as Guides → Configure your site remain navigable. Recursive `submenus` can extend the hierarchy without a fixed depth limit; `site.nestedMenusEnabled: false` keeps every destination in a flat presentation.
4141

@@ -45,6 +45,9 @@ Configure controls through `gitpagedocs/config.json` → `site.icons`. `Language
4545
`site.nestedMenusEnabled` selects recursive or flat navigation. Breadcrumbs use `RouteGuide` with route > version defaults > site precedence. `site.FocusMode` enables reading mode; `site.focusMode` controls copy, download, section navigation and document navigation independently.
4646

4747
Focus mode provides eight navigation buttons: first, previous, next and last document, plus first, previous, next and last section. Each navigation flag controls its group of four; document changes keep the reader open and restart at the first section.
48+
Focus narration reads only the displayed section. Section/document changes and entering/leaving focus stop the previous speech; a new reading uses the visible content while retaining voice, speed and volume preferences. With `sectionNavigationEnabled: false`, the whole document is visible and narratable. Source copy/download still covers the complete document.
49+
50+
Documentation pages and the introduction guide use `site.backToTop: { enabled: true, minPageHeightViewports: 3 }` for their back-to-top arrow. It is available only on a scrollable page at least three viewport heights tall. Set `enabled: false` to hide it; the threshold accepts a finite number greater than 1 and otherwise defaults to 3.
4851

4952
Document-footer controls use `DocumentPrevious` (`LuChevronLeft`) and `DocumentNext` (`LuChevronRight`); either can use its translated text with `reactIcon: false`. The footer appears for multiple available menu destinations and disables unavailable directions. `site.ActiveNavigation` controls quick navigation and Ctrl+K separately.
5053

@@ -68,7 +71,7 @@ Read or download the [GitPageDocs project guide (PDF, English)](cli/content/asse
6871
Configure `site.pdf` with `enabled`, `previewEnabled`, `downloadEnabled` and `openInNewTabEnabled` (all default to `true`). The version config uses `routes-pdf`, `pdf.pathPdf` per language and `menus-header-pdf` with `page:23` for the bundled example. Route-level preview/download/new-tab options go inside `pdf`; `hierarchyPage.pdf` and `hierarchyMenu.pdf` order the content and menu sections.
6972

7073
```json
71-
{ "id": 23, "pdf": { "pathPdf": { "en": "gitpagedocs/docs/versions/0.0.12/en/gitpagedocs-project-guide.pdf", "pt": "gitpagedocs/docs/versions/0.0.12/en/gitpagedocs-project-guide.pdf", "es": "gitpagedocs/docs/versions/0.0.12/en/gitpagedocs-project-guide.pdf" }, "previewEnabled": true, "downloadEnabled": true, "openInNewTabEnabled": true } }
74+
{ "id": 23, "pdf": { "pathPdf": { "en": "gitpagedocs/docs/versions/0.0.13/en/gitpagedocs-project-guide.pdf", "pt": "gitpagedocs/docs/versions/0.0.13/en/gitpagedocs-project-guide.pdf", "es": "gitpagedocs/docs/versions/0.0.13/en/gitpagedocs-project-guide.pdf" }, "previewEnabled": true, "downloadEnabled": true, "openInNewTabEnabled": true } }
7275
```
7376

7477
The native browser viewer handles PDF previews and new tabs through validated `application/pdf` Blob URLs. Preview, download and new-tab actions all require CORS permission for external files. Opening a new tab does not navigate to the raw repository URL, so that server's Content-Type/Content-Disposition does not force a download. Browser PDF support and user preferences still apply. With preview disabled, the first download or new-tab action loads the PDF; cached bytes are reused. File/network errors and blocked pop-ups are reported without silently falling back to the raw URL.
@@ -98,13 +101,13 @@ Keep both `routes-html` and `menus-header-html` in the version configuration. Me
98101
"title": { "en": "DOOM: HTML example", "pt": "DOOM: exemplo HTML", "es": "DOOM: ejemplo HTML" },
99102
"description": { "en": "Load an interactive HTML demo", "pt": "Carregue uma demonstração HTML interativa", "es": "Carga una demostración HTML interactiva" },
100103
"titleIsVisible": true, "descriptionIsVisible": true, "container": "full",
101-
"path": { "en": "gitpagedocs/docs/versions/0.0.12/en/doom.html", "pt": "gitpagedocs/docs/versions/0.0.12/pt/doom.html", "es": "gitpagedocs/docs/versions/0.0.12/es/doom.html" }
104+
"path": { "en": "gitpagedocs/docs/versions/0.0.13/en/doom.html", "pt": "gitpagedocs/docs/versions/0.0.13/pt/doom.html", "es": "gitpagedocs/docs/versions/0.0.13/es/doom.html" }
102105
}],
103106
"menus-header-html": [{
104107
"id": 29,
105-
"en": { "title": "DOOM: HTML example", "path-click": "gitpagedocs/docs/versions/0.0.12/en/doom.html" },
106-
"pt": { "title": "DOOM: exemplo HTML", "path-click": "gitpagedocs/docs/versions/0.0.12/pt/doom.html" },
107-
"es": { "title": "DOOM: ejemplo HTML", "path-click": "gitpagedocs/docs/versions/0.0.12/es/doom.html" }
108+
"en": { "title": "DOOM: HTML example", "path-click": "gitpagedocs/docs/versions/0.0.13/en/doom.html" },
109+
"pt": { "title": "DOOM: exemplo HTML", "path-click": "gitpagedocs/docs/versions/0.0.13/pt/doom.html" },
110+
"es": { "title": "DOOM: ejemplo HTML", "path-click": "gitpagedocs/docs/versions/0.0.13/es/doom.html" }
108111
}]
109112
}
110113
```

0 commit comments

Comments
 (0)