Skip to main content

HTML Output

The HTML format produces self-contained .html files that can be opened in any web browser. It is available on all plans and provides the most interactive reading experience of the standard output formats.

Single-File Design​

Each HTML page is a standalone file with embedded CSS and JavaScript. The only external dependency is Google Fonts (Inter for body text, Manrope for headlines), which are loaded automatically when the file is opened in a browser with internet access. If fonts cannot be loaded, the page falls back to system fonts.

This design makes sharing straightforward: attach the file to an email, upload it to a shared drive, or host it on any web server.

Interactive Features​

Expandable Sections​

Each section of the documentation is wrapped in a collapsible block. Click a section header to expand or collapse its content. This lets you focus on the specific area you are reviewing without scrolling through the entire document.

A fixed sidebar on the left (260px wide) displays a table of contents built from the page headings. As you scroll, the sidebar highlights the currently visible section using scroll-spy JavaScript. Click any entry to jump directly to that section.

KPI Banners​

Object pages display a statistics banner at the top showing key metrics such as total rule count, blocking validation count, and overall confidence level. Metrics are color-coded: red for blocking validations, green for high confidence.

Content Structure​

The HTML output contains the same documentation content as the Markdown format, rendered with visual styling:

  • Object overview -- business label, description, and summary metrics in a KPI banner.
  • Business rules -- rule cards with reference badges, condition/message/justification details, and type indicators.
  • Dependencies -- relationships displayed as structured tables.
  • Technical details -- field definitions, record types, and layout information.

Evidence Blocks​

Evidence for each business rule is rendered as a collapsible block. Click the evidence header to reveal the source metadata, affected fields, and conditions. This keeps the page clean while preserving full traceability.

Styling​

The HTML output uses aprity's default styling:

  • Typography: Manrope for headlines (600-700 weight), Inter for body text (15px base, line-height 1.65).
  • Colors: Indigo primary (#4F46E5), dark slate header bar (#1E293B), light background (#f7f9fb).
  • Badges: Color-coded for rule types -- blocking (red), automation (indigo), notification (orange), data (neutral).
  • Layout: Fixed header bar with aprity branding, fixed sidebar TOC, content area with 960px max-width.
  • Border radius: 4px on all cards, sections, and badges.
note

The HTML output is read-only. To make edits to the documentation content, use the Markdown or DOCX format instead.

Browser Compatibility​

The HTML output works in all modern browsers:

  • Google Chrome
  • Mozilla Firefox
  • Microsoft Edge
  • Apple Safari

Internet Explorer is not supported.

When to Use HTML​

  • You need a quick, shareable documentation file that anyone can open.
  • You want interactive navigation with collapsible sections and a sidebar TOC.
  • You are presenting documentation to stakeholders who prefer a browser-based reading experience.
  • You need a lightweight alternative to DOCX or PDF that still looks polished.