v0.1.0-alpha.0

OpenWebDoc v0.1.0-alpha.0

This is the first public alpha of OpenWebDoc and the HTMLX Document Package.
HTMLX is a browser-readable, agent-safe document package: one .htmlx file contains
HTML, CSS, local assets, an explicit manifest, provenance metadata, and user-visible
LLM reference metadata.

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

The app starts with a single .htmlx file-open screen. After a valid package is
loaded, the document is the primary surface. Read first, enable edit mode only for
small corrections, then export a validated package.

What Is Included

• A single OpenWebDoc runtime for reading .htmlx packages, micro-editing packages
  that declare metadata/editing.json, and exporting validated packages.
• A public template gallery with flow documents, fixed-stage visual documents, and
  HTMLX-native slide decks.
• HTMLX profile support for flow-document, fixed-stage-document, and slide-deck.
• CLI support for creating, validating, unpacking, packing, inspecting, and refreshing
  package metadata.
• Package validation for manifests, package-local resources, integrity hashes,
  script-free HTML, remote-resource blocking, path traversal defense, presentation
  metadata, editing metadata, and LLM metadata freshness.
• A repository-local GitHub Action for validating .htmlx files in other workflows.
• Agent workflow documentation for Codex, Claude Code, Cursor, GitHub Copilot, and
  Aider.

Recommended Workflow

Use the live app when you want to inspect or lightly correct a document.

Use the CLI when a coding agent or CI system edits package files:

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 --json

The unpacked package directory is 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 .htmlx packages
• 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.0