adr-viewer
« Back to VersTracker
Description:
Generate easy-to-read web pages for your Architecture Decision Records
Type: Formula  |  Latest Version: 1.4.0@4  |  Tracked Since: Dec 17, 2025
Links: Homepage  |  formulae.brew.sh
Category: Developer tools
Tags: documentation architecture adr static-site developer-tools
Install: brew install adr-viewer
About:
adr-viewer is a static site generator specifically designed for Architecture Decision Records (ADRs). It parses Markdown files from a repository and compiles them into a navigable, interactive HTML website. This transforms raw ADRs into an accessible knowledge base, making it easy for teams to browse and understand the technical evolution of a project.
Key Features:
  • Generates a single-page application (SPA) from Markdown ADRs
  • Provides a searchable and filterable interface for records
  • Zero-configuration setup with sensible defaults
  • Supports custom theming and styling
Use Cases:
  • Creating a public or internal documentation portal for a project's architectural history
  • Onboarding new team members by providing a clear overview of past technical decisions
  • Auditing and reviewing the consistency of ADRs across a large codebase
Alternatives:
  • adr-tools – adr-tools focuses on CLI-based creation and management of ADRs, whereas adr-viewer specializes in rendering them into a web UI.
  • mkdocs – mkdocs is a general-purpose static site generator that can host ADRs but requires more manual configuration compared to the ADR-specific focus of adr-viewer.
License: MIT
Dependencies: python@3.14
Bottles available for: arm64_tahoe, arm64_sequoia, arm64_sonoma, sonoma, arm64_linux, x86_64_linux
Version History
Detected Version Rev Change Commit
Nov 16, 2025 6:25pm 4 VERSION_BUMP efd8232e
Oct 10, 2025 1:40pm 4 VERSION_BUMP e626c63f
Jan 2, 2025 6:49am 2 VERSION_BUMP 0a4c9b6a