adr-viewer

使用adr-viewer，您可以轻松浏览架构决策记录的网页，无论是作为本地Web服务器还是生成的静态内容。使用代码块/围栏包含Mermaid格式的图表，例如 test ADR 5。

示例

• 上述示例使用Nat Pryce的adr-tools项目
• 此项目公开其自己的架构决策记录 在此处

安装

从PyPI

$ pip install adr-viewer

从Homebrew

$ brew install adr-viewer

请参阅adr-viewer公式页面。

从本地构建

adr-viewer需要Python 3.7或更高版本（带有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.

--adr-path的默认值是doc/adr/，因为这是adr-tools生成的默认路径。

支持的记录类型