structurizr / import

Utilities to import diagrams and documentation into a Structurizr workspace

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

ADR files can only be in Markdown format?

docbakery opened this issue · comments

I would like to use Asciidoc for all of my documentation and ADR files. But if I make ADRs in the Asciidoc format they don't work. They either don't show up if the file-extensions is .adoc or the Asciidoc markup is ignored when I use the .md file-extension.

When I use Markdown markup with the .md extension everything works correctly.

I'm using the .war version, build 2828.

There only exists a single ADR importer implementation at this time, which assumes the use of the adr-tools tool and Markdown. If you're using a different toolchain, you'll need to implement your own ADR importer. See https://github.com/structurizr/dsl/blob/master/docs/language-reference.md#architecture-decision-records-adrs for more.

Ok, thanks for the fast reply! In that case I will document the ADRs as part of the ARC42 Asciidoc templates I use under !docs