better-read-html

What problem does it solve?

It helps you create or validate source-first, browser-readable HTML that stays faithful to the original document text, with evidence-linked structure and a consistent, offline-friendly reader layout.

Core Features & Use Cases

• Create static HTML artifacts (source-first) for papers, technical reports, notes, plans, and specifications when the user specifically wants an offline/local/single-file/printable HTML deliverable.
• Choose a fidelity mode—preserve for exact conversion boundaries, annotate-synthesize for close reading and report-style explanation, or audit for verifying an existing HTML artifact.
• Protect source integrity by keeping canonical content unchanged and marking generated/layout duplicates as noncanonical, with link and asset validation.
• Use design that prioritizes readability with IBM Carbon-style, locally embedded CSS and structured semantic HTML (rails, figures, captions, equations, citations).
• Detect common HTML integrity issues via the included auditor script (ids, internal links, missing assets, remote dependencies, canonical-text mismatch in supported cases).

Quick Start

Use better-read-html to render or audit your HTML artifact by running the provided HTML audit script against the file you generated.