Skip to content

Commit 7dd3bf6

Browse files
committed
chore(release): 0.0.9 - configurable reading, navigation and PDF docs
Add configurable icon controls, recursive menus and breadcrumb overrides. Keep focus mode open across documents and expose Markdown copy/download actions. Coordinate native narration with audio and video playback. Add PDF routes, menus, native previews, download and new-tab actions with per-route authorization and settings. Publish the English project guide as a working example and expand the English, Portuguese and Spanish manuals. Resolve build helpers from the config file because Next 15's transpiled module lacks the filename needed for relative module resolution. Update the CLI, shared tools and MCP packages to 0.0.9.
1 parent be8179a commit 7dd3bf6

351 files changed

Lines changed: 21248 additions & 1282 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.

‎.gitattributes‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
*.pdf binary

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,4 @@ playwright-report
2020
# SonarQube scanner work dir
2121
.scannerwork
2222
.next-guide
23+
frontend/public/gitpagedocs

‎CONTRIBUTING.md‎

Lines changed: 27 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ This is a pnpm + turbo monorepo: `frontend/` (Next.js viewer), `cli/` (the publi
88
- `pnpm run lint` — lint the project
99
- `pnpm run test:unit` — run the Vitest unit/integration suite
1010
- `pnpm run test:cov` — unit tests with coverage
11-
- `pnpm run test:e2e` — Playwright frontend E2E
11+
- `pnpm exec cross-env PORT=3100 pnpm run test:e2e` — Playwright frontend E2E on ports 3100 and 3101
1212
- `pnpm run smoke:all` — CLI/contract/tools/mcp regression wall
13-
- `pnpm run build` — build the static site
13+
- `pnpm run build` — build the Next.js production runtime; Pages export additionally requires its build environment
1414

1515
### CLI commands
1616

@@ -20,7 +20,7 @@ This is a pnpm + turbo monorepo: `frontend/` (Next.js viewer), `cli/` (the publi
2020
- `gitpagedocs models [provider]` — list catalog models
2121
- `gitpagedocs ai` — interactive AI docs generator (writes pages in the gitpagedocs pattern)
2222
- `gitpagedocs chat [question]` — streaming AI chat in the terminal (REPL on a TTY; one-shot with a question or piped stdin)
23-
- `gitpagedocs document[:repo|:file|:folder]` — generate documentation with AI in the gitpagedocs pattern
23+
- `gitpagedocs document[:repo|:file|:folder]` — aliases of the interactive documentation generator; select input directories in its prompts
2424
- `gitpagedocs password` — set a documentation access password (writes the public key to config.json)
2525
- `gitpagedocs config clear` — delete the stored .gitpagedocsconfig and the encrypted key vault
2626
- `gitpagedocs docs` — refresh the managed regions of README, CONTRIBUTING and SECURITY
@@ -31,4 +31,28 @@ This is a pnpm + turbo monorepo: `frontend/` (Next.js viewer), `cli/` (the publi
3131
- `gitpagedocs mcp start` — start the MCP server over stdio
3232
- `gitpagedocs version` — print the CLI version
3333
- `gitpagedocs update` — check the registry for a newer CLI and print the install command
34+
35+
### User references
36+
37+
The generated versioned documentation includes dedicated pages for configuration, CLI, MCP, recursive navigation, focus mode, accessibility/narration, PDF documents, deployment, architecture, themes and troubleshooting. Each page is available in English, Portuguese and Spanish; Markdown filenames stay in English across languages.
38+
39+
Configure language, theme, focus and Ctrl+K control icons through `gitpagedocs/config.json` → `site.icons`. Set `reactIcon` independently on `LanguageSelector`, `ThemeSelector`, `FocusMode` and `QuickNavigation`; `false` keeps the text controls. Customize `tag`, `size`, `colorDark` and `colorLight` per entry.
40+
41+
`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.
42+
43+
`site.accessibility.narration` configures native browser reading. Voices and offline availability depend on the browser and operating system. `site.mediaExclusivePlayback` coordinates narration, radio, audio and video so only one audible source plays by default.
44+
45+
See [the MCP reference](mcp/README.md) for installation, client configuration, all 20 tools, all 7 resources, provider variables and limits. Start with `gitpagedocs mcp start` from the target project; on a source checkout the direct entry is `node --import tsx mcp/src/bin.ts`.
46+
47+
### PDF documents
48+
49+
Read or download the [GitPageDocs project guide (PDF, English)](cli/content/assets/gitpagedocs-project-guide.pdf). The CLI includes this real PDF in each generated version under `en/gitpagedocs-project-guide.pdf`; the example route points all three languages to the English document.
50+
51+
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.
52+
53+
```json
54+
{ "id": 23, "pdf": { "pathPdf": { "en": "gitpagedocs/docs/versions/0.0.9/en/gitpagedocs-project-guide.pdf", "pt": "gitpagedocs/docs/versions/0.0.9/en/gitpagedocs-project-guide.pdf", "es": "gitpagedocs/docs/versions/0.0.9/en/gitpagedocs-project-guide.pdf" }, "previewEnabled": true, "downloadEnabled": true, "openInNewTabEnabled": true } }
55+
```
56+
57+
The native browser viewer handles PDF previews through temporary Blob URLs after the file signature is validated. Both preview and download require CORS permission when the file comes from another origin. The new-tab link opens the original URL directly, where browser support and the server's Content-Type/Content-Disposition can cause a download instead of inline display. Next.js dev/build stages repository PDFs from `gitpagedocs/` into public assets and respects the Pages subpath; other local files must be in `frontend/public/`. See the generated PDF documents page for complete site, route and menu examples.
3458
<!-- gitpagedocs:end -->

0 commit comments

Comments
 (0)