Skip to content

Commit 8ff9b4d

Browse files
committed
[DOC] Better anchors in README
Now the README in the `type` section it says: > *Default:* `'file-hash'` > *Alternatives:* `'git-tag-commit'`, `'git-commit'`, `'version-commit'` So I tend to cmd+f for `git-tag-commit`, but that string is nowhere else to be found in the README. So I have to do some mental parsing to find the correct section. This will help people navigate around the README more quickly.
1 parent b71afd7 commit 8ff9b4d

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ You can also pass your own custom scm generator class.
7878

7979
Data generators are the strategies used to generate information about the revision being deployed. A data generator must return an object which contains a property called `revisionKey` which uniquely identifies the current revision. A generator can add any other data that it deems relevant to the data object that it returns.
8080

81-
### File Hash generator
81+
### File Hash generator (`file-hash`)
8282

8383
This generator contructs a revisionKey from the fingerprint of the `index.html` file.
8484

@@ -112,7 +112,7 @@ The list of built project files. This option should be relative to `distDir` and
112112

113113
*Default:* `context.distFiles`
114114

115-
### Git Tag Commit generator
115+
### Git Tag Commit generator (`git-tag-commit`)
116116

117117
Constructs a revision key based on the most recent git tag and the currently checked-out commit.
118118

@@ -134,7 +134,7 @@ The timestamp of the current deploy
134134

135135
The text used to separate the tag name from the commit sha. By default, `+` is used.
136136

137-
### Git Commit generator
137+
### Git Commit generator (`git-commit`)
138138

139139
Constructs a revision key based on the most recent git commit.
140140

@@ -150,7 +150,7 @@ For example, if the current commit is `0993043d49f9e0[...]`, this generator will
150150

151151
The timestamp of the current deploy
152152

153-
### Version Commit generator
153+
### Version Commit generator (`version-commit`)
154154

155155
Similar to the Git Tag Commit generator but uses the `package.json` version string to construct the revision key instead of the git tag.
156156

0 commit comments

Comments
 (0)