https://github.com/ninjascl/adr-asciidoc
A simple tool for creating Architectural Decision Records.
https://github.com/ninjascl/adr-asciidoc
adr asciidoc cli javascript tool
Last synced: about 1 year ago
JSON representation
A simple tool for creating Architectural Decision Records.
- Host: GitHub
- URL: https://github.com/ninjascl/adr-asciidoc
- Owner: NinjasCL
- License: bsd-2-clause
- Created: 2021-06-15T05:09:36.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2021-06-15T05:20:13.000Z (about 5 years ago)
- Last Synced: 2025-03-26T21:46:56.913Z (about 1 year ago)
- Topics: adr, asciidoc, cli, javascript, tool
- Language: JavaScript
- Homepage:
- Size: 8.79 KB
- Stars: 1
- Watchers: 2
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.adoc
- License: LICENSE
Awesome Lists containing this project
README
# Architectural Decision Log Tool
This log lists the architectural decisions for this project.
---
For new ADRs, please use *docs/templates/adr.template.adoc* as basis. You can easily create a new ADR with *adr* command based on the template:
```sh
./adr new My New ADR
```
For generating a new _README.adoc_ and _index.html_ use the _compile_ task:
```sh
./adr compile
```
Requires https://nodejs.org/en/[NodeJS] and https://asciidoctor.org/[ASCIIDoc] installed.
---
More information on MADR is available at .
General information about architectural decision records is available at .
++++
Made with ♥ by Ninjas.cl.
++++