adr-viewer
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-viewerFrom local build
adr-viewer requires Python 3.7 or higher (with Pip)
$ git clone https://github.com/mrwilson/adr-viewer
$ pip install -r requirements.txt
$ python setup.py installUsage
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/
--port INT Custom server port [default: 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
