Skip to content

Commit

Permalink
improved docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Muhammad-Owais-Warsi committed Oct 24, 2024
1 parent 3908a63 commit 71038f9
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions website/docs/configuration/git.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,8 @@ Custom OS commands can also be used for modifying the commit messages:

- `{ pattern = "foo", replace_command = "pandoc -t commonmark"}`

> The above is equivalent to: `echo <macthed_part_of_the_changelog> | pandoc -t commonmark`

Check warning on line 133 in website/docs/configuration/git.md

View workflow job for this annotation

GitHub Actions / Typos

"macthed" should be "matched".
This is useful when you want to filter/encode messages using external commands. In the example above, [pandoc](https://pandoc.org/) is used to convert each commit message that matches the given `pattern` to the [CommonMark](https://commonmark.org/) format.

A more fun example would be reversing each commit message:
Expand Down

0 comments on commit 71038f9

Please sign in to comment.