v0.1.0-alpha.2
Pre-releaseOpenWebDoc v0.1.0-alpha.2
This alpha refresh fixes the public GitHub Action validator for external
repositories and tightens the example-gallery release gate.
HTMLX remains an alpha-stage browser-readable document package. The recommended
public adoption path is to add one .htmlx package to a repository, validate it
in pull requests, and let coding agents edit unpacked package files only inside
the validated package boundary.
What Changed Since v0.1.0-alpha.1
- The repository-local GitHub Action now builds
@openwebdoc/specand
@openwebdoc/corebefore building@openwebdoc/cli, so external repositories
can use the action from a release tag without relying on prebuilt workspace
artifacts. - The template gallery release check now compares each gallery entry profile with
the source package manifest profile. - General document templates now advertise
flow-documentinstead of
fixed-stage-documentwhen their manifests are flow-native. - Flow document examples use realistic reader-facing sample content instead of
OpenWebDoc release or implementation-status copy. - The README now highlights a 10-minute PR gate adoption path through starter
repositories and theAgentic Document Integritycheck.
Try It
- Open the app: https://lhy0718.github.io/OpenWebDoc/app/
- Browse the template gallery: https://lhy0718.github.io/OpenWebDoc/
- Read the introduction example: https://lhy0718.github.io/OpenWebDoc/app/?example=openwebdoc-introduction
- Open the slide deck example: https://lhy0718.github.io/OpenWebDoc/app/?example=openwebdoc-slide-deck
Recommended GitHub Action
Use the tag-pinned action in repositories that want a readable alpha reference:
- uses: lhy0718/OpenWebDoc/.github/actions/validate-htmlx@v0.1.0-alpha.2
with:
paths: |
docs/**/*.htmlx
examples/*.htmlxSecurity-sensitive repositories can pin the same release tag to its resolved commit
SHA after the release is created.
Recommended Package Workflow
pnpm htmlx unpack input.htmlx ./work --json
# edit ./work/index.html, styles/*, metadata/*, and declared assets
pnpm htmlx refresh-metadata ./work --json
pnpm htmlx refresh-metadata ./work --check --json
pnpm htmlx validate ./work --json
pnpm htmlx pack ./work edited.htmlx --json
pnpm htmlx validate edited.htmlx --jsonThe unpacked package directory remains the canonical boundary for external
AI-agent editing. The browser app does not call model providers, store API keys,
generate hidden instructions, or perform large document redesigns.
Release Assets
This release attaches:
- valid example
.htmlxpackages - npm package tarballs for inspection
- a generated release manifest
- a compressed spec and docs snapshot
The intentionally invalid security fixture is not a release asset. It remains in
the repository as validator test data.
Current Boundaries
- This is an alpha preview, not a stable format release.
- npm publishing is intentionally disabled; tarballs are attached for inspection
only. - The app is a trusted runtime and micro-edit surface, not a full document design
suite. - Large rewrites, new figures, new tables, new slides, or structural redesigns
should be done by editing unpacked package files and validating before
repacking. - DOCX, HWPX, PDF, cloud sync, plugin systems, browser-side model calls, and
arbitrary package JavaScript execution are outside this alpha scope.
Useful Links
- App: https://lhy0718.github.io/OpenWebDoc/app/
- Template gallery: https://lhy0718.github.io/OpenWebDoc/
- Repository: https://github.com/lhy0718/OpenWebDoc
- Release: https://github.com/lhy0718/OpenWebDoc/releases/tag/v0.1.0-alpha.2