adr-tools icon indicating copy to clipboard operation
adr-tools copied to clipboard

Add support for Asciidoc

Open rlemaitre opened this issue 4 years ago • 4 comments

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

rlemaitre avatar May 25 '20 17:05 rlemaitre

Would love to see this merged!

devth avatar Oct 22 '20 20:10 devth

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 )

sakirtemel avatar Jan 01 '24 23:01 sakirtemel

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

rlemaitre avatar Jan 03 '24 10:01 rlemaitre

Things start looking like abandonware 😔

silopolis avatar Feb 21 '24 08:02 silopolis