search

npryce / adr-tools

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

Allow overwriting of default TOC title #67

Open domdoescode opened 6 years ago

domdoescode commented 6 years ago

Currently the Table of Contents title is hard coded. Being able to change this would be advantageous where others may want the project name instead, especially as this is always before the intro contents.

https://github.com/npryce/adr-tools/blob/master/src/_adr_generate_toc#L47

Overwriting with -t or a similar arg could be used to achieve this.

chchrist commented 5 years ago

I think it is better to define a template for the TOCs than just override the title. For example I might not want it as an ordered list. Instead of intro, outro and prefix etc you could just specify a template and pass the variables. If I find some time I will give it a go