Skip to content

Build offline-friendly docs for VIPM distribution#26

Open
Tom-McQuillan wants to merge 2 commits intomainfrom
test-offline
Open

Build offline-friendly docs for VIPM distribution#26
Tom-McQuillan wants to merge 2 commits intomainfrom
test-offline

Conversation

@Tom-McQuillan
Copy link
Collaborator

@Tom-McQuillan Tom-McQuillan commented Oct 21, 2025

Add Offline Documentation Build

Summary

Adds offline-friendly documentation build for bundling with VIPM installations.

This PR scopes the level of effort required to build offline documentation (replacing CHM files) for use in VIPM.

Changes

  • New build-offline job creates vipm-help-offline.zip with flat URLs
  • Works offline by double-clicking index.html (no web server needed)
  • Supports Windows and Linux (replaces Windows-only CHM files)
  • Online docs deployment unchanged

Testing

Download vipm-help-offline-XXX.zip artifact, extract, and open index.html

Artifacts

  • site-online-pr-XXX - Web version for GitHub Pages
  • vipm-help-offline-XXX.zip - Offline version for VIPM distribution

@github-actions

This comment was marked as outdated.

@Tom-McQuillan Tom-McQuillan changed the title Test offline build Add offline documentation build for cross-platform VIPM help Oct 21, 2025
@Tom-McQuillan Tom-McQuillan changed the title Add offline documentation build for cross-platform VIPM help Build offline-friendly docs for VIPM distribution Oct 21, 2025
@github-actions
Copy link

Documentation Build Successful

Built in both online and offline formats.

Online Version (GitHub Pages)

  • Artifact: site-online-pr-26
  • Use with a web server: python -m http.server

Offline Version (for VIPM distribution)

  • Artifact: vipm-help-offline-26.zip
  • Works by double-clicking index.html

Download artifacts: https://github.com/vipm-io/docs/actions/runs/18680078186

To test offline:

  1. Download vipm-help-offline-26.zip
  2. Extract and open index.html

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