Skip to content

docs(antora): consolidate docs image to offline "markup-antora" build#781

Merged
michalharakal merged 1 commit into
developfrom
chore/docs-markup-antora
Jun 29, 2026
Merged

docs(antora): consolidate docs image to offline "markup-antora" build#781
michalharakal merged 1 commit into
developfrom
chore/docs-markup-antora

Conversation

@michalharakal

Copy link
Copy Markdown
Contributor

Replace the per-repo Antora docs image with the consolidated "markup-antora" definition (one image shared across the SKaiNET docs projects, vendored here until the public registry image is published).

Features of the merged image:

  • Offline Mermaid: every [mermaid] block is rendered to inline SVG at build time by mermaid-cli (Alpine Chromium + Puppeteer) via the baked local-mermaid-extension.js block processor. No Kroki, no kroki.io, no network at build or view time.
  • Diagram caching: content-hash, in-memory + optional on-disk (MERMAID_CACHE_DIR); identical diagrams render once.
  • Rootless-safe under --user $(id -u):$(id -g) (HOME=/tmp + cleanup of root-owned /tmp dirs; fixes Chromium crashpad / cosmiconfig EACCES).
  • Build-time mermaid smoke test (a broken image fails docker build).
  • Offline extras available: @antora/lunr-extension, pre-baked Antora UI bundle, MathJax es5; asciidoctor-kroki kept as an escape hatch.
  • Full Alpine font set for diagram labels, emoji and CJK.

local-mermaid-extension.js now dedupes identical diagrams via a content-hash cache. puppeteer-config.json is a real file (was echoed inline). CI is unchanged: docs.yml already builds from docs/.docker.

Usage and details: see docs/.docker/README.md.

Replace the per-repo Antora docs image with the consolidated
"markup-antora" definition (one image shared across the SKaiNET docs
projects, vendored here until the public registry image is published).

Features of the merged image:
- Offline Mermaid: every [mermaid] block is rendered to inline SVG at
  build time by mermaid-cli (Alpine Chromium + Puppeteer) via the baked
  local-mermaid-extension.js block processor. No Kroki, no kroki.io, no
  network at build or view time.
- Diagram caching: content-hash, in-memory + optional on-disk
  (MERMAID_CACHE_DIR); identical diagrams render once.
- Rootless-safe under --user $(id -u):$(id -g) (HOME=/tmp + cleanup of
  root-owned /tmp dirs; fixes Chromium crashpad / cosmiconfig EACCES).
- Build-time mermaid smoke test (a broken image fails docker build).
- Offline extras available: @antora/lunr-extension, pre-baked Antora UI
  bundle, MathJax es5; asciidoctor-kroki kept as an escape hatch.
- Full Alpine font set for diagram labels, emoji and CJK.

local-mermaid-extension.js now dedupes identical diagrams via a
content-hash cache. puppeteer-config.json is a real file (was echoed
inline). CI is unchanged: docs.yml already builds from docs/.docker.

Usage and details: see docs/.docker/README.md.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@michalharakal michalharakal merged commit c6e485a into develop Jun 29, 2026
6 checks passed
@michalharakal michalharakal deleted the chore/docs-markup-antora branch June 29, 2026 12:09
@github-actions

Copy link
Copy Markdown

📖 Documentation Preview

The documentation has been built successfully for this PR.

Generated Files:

  • Operator documentation: docs/modules/operators/_generated_/
  • JSON schema output: operators.json

Artifacts:

  • Download the documentation-preview-781 artifact to view the complete documentation locally.

This comment will be updated automatically when the PR is updated.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant