search

npryce / adr-tools

Command-line tools for working with Architecture Decision Records
Other
4.53k stars 578 forks source link

Add support for Asciidoc #101

Open rlemaitre opened 4 years ago

rlemaitre commented 4 years ago

This implements issue #73: provide the choice of the file format when initialising ADR log.

I added the -t option to adr init that stores in the .adr-file-type file the chosen format (markdown by default). Format values can be md for Markdown or adoc for AsciiDoc.

I duplicated all tests (except the one that checks a title is given to adr new) to ensure AsciiDoc is managed properly.

I didn't managed hybrid logs (containing MarkDown and AsciiDoc), nor migration from MarkDown to AsciiDoc. The migration could be handled via documentation by creating manually .adr-file-type file and running Kramdoc or Pandoc.

My bash is far from perfect, can anyone look at this PR?

Thanks

devth commented 3 years ago

Would love to see this merged!

sakirtemel commented 7 months ago

Hi, any updates on this? This would work great with Antora and Arc42 if this gets merged (similar to here https://github.com/anoff/antora-arc42/tree/master/docs/modules/adr/pages )

rlemaitre commented 7 months ago

I was wondering, too. I'm more and more thinking about writing my own tool

silopolis commented 6 months ago

Things start looking like abandonware 😔