Skip to content

Commit

Permalink
Improve examples in README (#7)
Browse files Browse the repository at this point in the history
  • Loading branch information
rhshadrach authored Aug 13, 2024
1 parent ea273aa commit d76f981
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@ plugins:
autolinks:
- reference_prefix: GH-<num>
target_url: https://github.com/myname/myproject/issues/<num>
- reference_prefix: COMPLEX-<num>-<ver>
target_url: https://jiracloud.com/COMPLEX-<num>?ver=<ver>
- reference_prefix: JIRA-<num>-<ver>
target_url: https://jiracloud.com/myproject-<num>?ver=<ver>
```
- __filter_links__: When `True`, will not make replacements within existing markdown links. Caution: This may impact performance in large environments. Defaults to `False`.
Expand All @@ -41,7 +41,8 @@ For example, you could edit the `docs/index.md` file and insert the ticket refer

Changelog:

- GHI-100: add new feature.
- GHI-100: Add new feature.
- JIRA-231-XYZ: Fix bug.

````

Expand All @@ -50,7 +51,8 @@ This will be converted to:
```
Changelog:
- [GHI-100](https://github.com/myname/myproject/issues/100): add new feature.
- [GHI-100](https://github.com/myname/myproject/issues/100): Add new feature.
- [JIRA-231-XYZ](https://jiracloud.com/myproject-231?ver=XYZ): Fix bug.
```

Expand Down

0 comments on commit d76f981

Please sign in to comment.