Skip to content

Commit

Permalink
docs: Add --template examples
Browse files Browse the repository at this point in the history
  • Loading branch information
pawamoy committed Nov 4, 2023
1 parent e016965 commit 6551e68
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -196,11 +196,23 @@ for each commit message convetions.
Both are very similar, they just differ with the formatting a bit.
We stronly recommend the `keepachangelog` format.

Use the `-t`, `--template` option to specify the template to use:

```bash
git-changelog --template keepachangelog
```

You can also write and use your own changelog templates.
Templates are single files written using the [Jinja][jinja] templating engine.
You can get inspiration from
[the source of our built-in templates](https://github.com/pawamoy/git-changelog/tree/master/src/git_changelog/templates).

Prefix value passed to the `--template` option with `path:` to use a custom template:

```bash
git-changelog --template path:mytemplate.md
```

## Filter commits

Sometimes it may be useful to use a limited set of commits, for example, if your
Expand Down

0 comments on commit 6551e68

Please sign in to comment.