Skip to content

Latest commit

 

History

History
55 lines (38 loc) · 1.79 KB

README.md

File metadata and controls

55 lines (38 loc) · 1.79 KB
Raw

Architecture Decision Records

ADRs are automatically published to our Log4brains architecture knowledge base:

🔗 http://INSERT-YOUR-LOG4BRAINS-URL

Please use this link to browse them.

Development

If not already done, install Log4brains:

npm install -g log4brains

To preview the knowledge base locally, run:

log4brains preview

In preview mode, the Hot Reload feature is enabled: any change you make to a markdown file is applied live in the UI.

To create a new ADR interactively, run:

log4brains adr new

Mermaid support

Log4brains does not support Github Mermaid Diagrams diagrams by default.

To successfully render Mermaid diagrams on the server side, add the following code to your ADR:

<pre class="mermaid">
  ... your mermaid code here ...
</pre>
<script src="https://cdnjs.cloudflare.com/ajax/libs/mermaid/9.2.1/mermaid.min.js"/>
<script>
  mermaid.initialize({ startOnLoad: true });
</script>

Unfortunately, this diagram won't be automatically rendered in your preview mode. So, you could debug using github mermaid diagrams, but then integrate the code above in your ADR.

More information