rsyslog/.codespellrc
Andre Lorbach 83bb383529 doc: vendor mermaid assets and fix offline viewing
Add vendored copies of Mermaid, layout-elk, and D3 JavaScript assets
under doc/source/_static to make documentation builds self-contained
and compliant with packaging policies that forbid CDN dependencies.

Changes:
- Add vendored JavaScript files for Mermaid (11.2.0), layout-elk (0.1.4),
  and D3 (7.9.0) under doc/source/_static/vendor
- Force sphinxcontrib-mermaid to use vendored assets via configuration
  overrides and install_js monkey-patching
- Create tools/fix-mermaid-offline.py script to convert ES module syntax
  to regular script tags for offline compatibility with file:// URLs
- Update doc/Makefile to automatically run the offline fix after builds
- Switch zoom helper bindings to const for modern JavaScript consistency
- Add .codespellignore to skip minified JavaScript files in vendor
  directory and exclude common minified JS tokens from spell checking

The documentation now works seamlessly both offline (file:// URLs) and
online (http:// URLs). Basic Mermaid diagrams render correctly in both
cases. ELK layout functionality remains unavailable in offline mode due
to browser CORS restrictions on ES modules.

This resolves CORS errors that occurred when opening HTML files directly
in a browser, eliminating the need to serve files via a local HTTP server.

Fixes: https://github.com/rsyslog/rsyslog/issues/6255
2025-10-22 09:28:11 +02:00

4 lines
123 B
Plaintext

[codespell]
skip = doc/source/_static/vendor
ignore-words-list = a11y,aac,ba,cd,com,et,fo,nd,ot,rd,st,te,ue,Bu,Fo,Nd,Te,Ue