Skip to content

Commit fa370dd

Browse files
committed
Added anchor link to mode and some few improvements to configuration.md
1 parent c400025 commit fa370dd

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

docs/configuration.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ after installing via chocolatey and a minimal `GitVersion.yml` configuration
2525
file will be created. Modify this as you need.
2626

2727
## Global configuration
28-
The global configuration options look like this:
28+
The global configuration look like this:
2929

3030
```yaml
3131
next-version: 1.0
@@ -47,7 +47,7 @@ ignore:
4747
commits-before: yyyy-MM-ddTHH:mm:ss
4848
```
4949
50-
The options are:
50+
And the description of the available options are:
5151
5252
### next-version
5353
Allows you to bump the next version explicitly, useful for bumping `master` or a
@@ -122,7 +122,7 @@ in the commit message. See the `*-version-bump-message` options above for
122122
details on the syntax. Default set to `Enabled`; set to `Disabled` to disable.
123123

124124
### ignore
125-
The header for ignore configuration
125+
The header for ignore configuration.
126126

127127
#### sha
128128
A sequence of SHAs to be excluded from the version calculations. Useful when
@@ -204,15 +204,16 @@ values, but here they are if you need to:
204204
The header for all the individual branch configuration.
205205

206206
### mode
207-
Same as for the global configuration, explained above.
207+
Same as for the [global configuration, explained above](#mode).
208208

209209
### tag
210210
The pre release tag to use for this branch. Use the value `useBranchName` to use
211211
the branch name instead. For example `feature/foo` would become a pre-release
212212
tag of `foo` with this value. Use the value `{BranchName}` as a placeholder to
213213
insert the branch name. For example `feature/foo` would become a pre-release tag
214-
of `alpha.foo` with the value of `alpha.{BranchName}`. **Note:** To clear a
215-
default use an empty string: `tag: ''`
214+
of `alpha.foo` with the value of `alpha.{BranchName}`.
215+
216+
**Note:** To clear a default use an empty string: `tag: ''`
216217

217218
### increment
218219
The part of the SemVer to increment when GitVersion detects it needs to be (i.e

0 commit comments

Comments
 (0)