From a6313a906286cd8768f9b407b009edd21a11ec54 Mon Sep 17 00:00:00 2001 From: Matthias Schoettle Date: Wed, 18 Mar 2026 16:10:27 -0400 Subject: [PATCH] Fix customization example in README Updated the example usage of the adr_summary function to include a custom template path and added a title to the default template markdown. Signed-off-by: Matthias Schoettle --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 58cd254..46e488a 100644 --- a/README.md +++ b/README.md @@ -52,12 +52,12 @@ The page output is generated using a jinja template, but you can provide a custo must still be relative to the `mkdocs.yml` file. ```markdown -{{ adr_summary(adr_path="docs/adr", adr_style="MADR3",m) }} +{{ adr_summary(adr_path="docs/adr", adr_style="MADR3", template="templates/adr-summary.jinja") }} ``` The default template is: -```markdown +```markdown title="templates/adr-summary.jinja" | ID | Date | Decision | Status | |----|------|----------|--------| {% for d in documents %}| {{ d.document_id }} | {{ d.date.strftime('%d-%m-%Y') if d.date else "-"}} | [{{ d.title }}]({{ d.file_path }}) | {{ d.status }} |