Skip to content
Generate easy-to-read web pages for your Architecture Decision Records
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
adr_viewer
doc/adr
docs
images
test/adr
.gitignore
.travis.yml
LICENSE
README.md
pa11y.json
requirements.txt
setup.py

README.md

adr-viewer

Build Status

Show off your Architecture Decision Records with an easy-to-navigate web page, either as a local web-server or generated static content.

Examples

  • Example above using Nat Pryce's adr-tools project
  • This project exposes its own Architecture Decision Records here

Installation

From PyPI

$ pip install adr-viewer

From local build

adr-viewer requires Python 2.7 (with Pip)

$ git clone https://github.com/mrwilson/adr-viewer
$ pip install -r requirements.txt
$ python setup.py install

Usage

Usage: adr-viewer [OPTIONS]

Options:
  --adr-path TEXT  Directory containing ADR files.  [default: doc/adr/]
  --output TEXT    File to write output to.  [default: index.html]
  --serve          Serve content at http://localhost:8000/
  --help           Show this message and exit.

The default for --adr-path is doc/adr/ because this is the default path generated by adr-tools.

Supported Record Types

You can’t perform that action at this time.