Skip to content

Commit 2442808

Browse files
committed
docs: tweak them a bit
1 parent 9370427 commit 2442808

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -94,19 +94,21 @@ You can configure `standard-version` either by:
9494
Any of the command line parameters accepted by `standard-version` can instead
9595
be provided via configuration. Please refer to the [conventional-changelog-config-spec](https://github.com/conventional-changelog/conventional-changelog-config-spec/) for details on available configuration options.
9696

97-
As an example, suppose you're using GitLab, rather than GitHub, you might modify the following variables:
97+
### Customizing CHANGELOG Generation
98+
99+
By default (as of `6.0.0`), `standard-version` uses the [conventionalcommits preset](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-conventionalcommits).
100+
101+
This preset adheres closely to the [conventionalcommits.org](https://www.conventionalcommits.org) specification.
102+
103+
Suppose you're using GitLab, rather than GitHub, you might modify the following variables:
98104

99105
* `commitUrlFormat`: the URL format of commit SHAs detected in commit messages.
100106
* `compareUrlFormat`: the URL format used to compare two tags.
101107
* `issueUrlFormat`: the URL format used to link to issues.
102108

103109
Making these URLs match GitLab's format, rather than GitHub's.
104110

105-
### Customizing CHANGELOG Generation further
106-
107-
By default (as of `6.0.0`), `standard-version` uses the [conventionalcommits preset](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-conventionalcommits).
108-
109-
This preset adheres closely to the [conventionalcommits.org](https://www.conventionalcommits.org) specification.
111+
### Deeper customization
110112

111113
You can override both [parser](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-commits-parser) and [writer](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-writer) options (they will be merged into the preset we just mentioned). As an example, to list commits in the order that they were committed:
112114

0 commit comments

Comments
 (0)