Show off your Architecture Decision Records with an easy-to-navigate web page, either as a local web-server or generated static content. Include diagrams in Mermaid format using code blocks/fences, e.g. test ADR 5.
$ pip install adr-viewer
$ brew install adr-viewer
See also the adr-viewer formula page.
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 install
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]
--title TEXT The project title [default: the basename of the current directory]
--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.
FAQs
A visualisation tool for Architecture Decision Records
We found that adr-viewer demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Fluent Assertions is facing backlash after dropping the Apache license for a commercial model, leaving users blindsided and questioning contributor rights.
Research
Security News
Socket researchers uncover the risks of a malicious Python package targeting Discord developers.
Security News
The UK is proposing a bold ban on ransomware payments by public entities to disrupt cybercrime, protect critical services, and lead global cybersecurity efforts.