Skip to content

v0.1.0-alpha.1

Pre-release
Pre-release

Choose a tag to compare

View all tags
@github-actions github-actions released this 02 Jun 07:41
· 15 commits to main since this release
v0.1.0-alpha.1
5e00f71
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

OpenWebDoc v0.1.0-alpha.1

This alpha refreshes the first public OpenWebDoc preview with cleaner release
packaging, user-facing release notes, and the latest GitHub Pages template gallery.
It is the recommended alpha build for trying the HTMLX Document Package today.

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

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 Changed Since v0.1.0-alpha.0

  • GitHub Release notes now come from a tracked docs/releases/<tag>.md file instead
    of an auto-generated changelog.
  • Release assets include only valid public .htmlx examples; the intentionally
    invalid security fixture remains repository-only test data.
  • The release workflow opts JavaScript actions into the Node 24 action runtime.
  • The release checklist now gates release-note quality, valid example assets,
    metadata freshness, packed-source drift, and public example copy identity.

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

Assets 22
Loading