This is a list of all the supported formatters for Loglette.
You can specify the formatter to use by using the -f <formatter> argument
where <formatter> is an alias of the formatter you want to use.
Example: -f md and -f markdown select the Markdown Formatter
(which is the default anyway)
time_format (optional): strftime format template for the release date
Aliases: md, markdown
This formatter currently doesn’t support any options (apart from the general options)
Aliases: html
The HTML Formatter requires Mistune and Jinja2 to be installed! You can make use of the extra dependency
htmlto automatically install them:
pip install loglette[html]
template (optional): A Jinja2 template string.
The template is rendered using the following variables:
| Variable | Description |
|---|---|
| changelog | The [Changelog] instance being formatted |
| change_types | A dictionary mapping the name of a change_type to a list of all the changes the belong to it |
| release | The formatted release date |
| options | Options passed to the formatter |
| md2html | A function that converts a markdown string to HTML |