-
Notifications
You must be signed in to change notification settings - Fork 128
Markdown docs use 'custom' template and don't show/mention default available #545
Description
Hi,
(PR incoming, but opening this first so I can get the news snippet right).
The Markdown docs specify how to set up a custom changelog.d/changelog_template.jinja file, but these docs predate #483 , which will use the default.md template for a .md changelog file by default - so for users, it would likely just be simpler to depend on a default template than to copy/paste the 'custom' one specified in the docs.
The default.md template seems to also add complexity to handle more cases, and has another couple of desirable features I found, so is likely to be preferred anyway:
- the 'custom' template from the docs will add trailing whitespace at the end of lines that are 'orphan snippets' without an issue
- the
default.mdtemplate puts brackets around issues in a way that seems to match Keep A Changelog more closely, and matching Keep A Changelog is (part of) the objective of that page in the docs.
I think it would be useful for it to be clear to users who want to use markdown that they don't need to configure a template themselves to get towcrier working with markdown - either by switching the docs to just use the default template, or by explicit discussion of this option in the docs.
I suspect the current situation is just a historical consequence of #436 coming a good while before #483 rather than a deliberate choice, but please correct me if I'm wrong!
While I'm writing, thanks for towncrier, I've found it very useful!