Skip to content

Commit 9f08899

Browse files
committed
Tweak readme headings
1 parent bac0248 commit 9f08899

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ You can also set any option in `package.json` under the `auto-changelog` key, us
9494
}
9595
```
9696

97-
#### Requirements
97+
### Requirements
9898

9999
`auto-changelog` is designed to be as flexible as possible, providing a clear changelog for any project. There are only two absolute requirements:
100100

@@ -106,7 +106,7 @@ There are some less strict requirements to improve your changelog:
106106
- [Close issues using keywords](https://help.github.com/articles/closing-issues-using-keywords)
107107
- Merge pull requests using the standard merge commit message for your platform
108108

109-
#### What you might do if you’re clever
109+
### What you might do if you’re clever
110110

111111
Install `auto-changelog` to dev dependencies:
112112

@@ -135,15 +135,15 @@ Using `-p` or `--package` uses the `version` from `package.json` as the latest r
135135

136136
Now every time you run [`npm version`](https://docs.npmjs.com/cli/version), the changelog will automatically update and be part of the version commit.
137137

138-
#### Breaking changes
138+
### Breaking changes
139139

140140
If you use a common pattern in your commit messages for breaking changes, use `--breaking-pattern` to highlight those commits as breaking changes in your changelog. Breaking change commits will always be listed as part of a release, regardless of any `--commit-limit` set.
141141

142142
```bash
143143
auto-changelog --breaking-pattern "BREAKING CHANGE:"
144144
```
145145

146-
#### Custom templates
146+
### Custom templates
147147

148148
If you aren’t happy with the default templates or want to tweak something, you can point to a [handlebars](http://handlebarsjs.com) template in your local repo. Check out the [existing templates](templates) to see what is possible.
149149

@@ -180,7 +180,7 @@ To see exactly what data is passed in to the templates, you can generate a JSON
180180
auto-changelog --template json --output changelog-data.json
181181
```
182182

183-
#### `commit-list` helper
183+
### `commit-list` helper
184184

185185
Use `{{#commit-list}}` to render a list of commits depending on certain patterns in the commit messages:
186186

@@ -207,7 +207,7 @@ Use `{{#commit-list}}` to render a list of commits depending on certain patterns
207207
| `subject` | A regex pattern to match against the commit subject only |
208208
| `exclude` | A regex pattern to exclude from the list – useful for avoiding listing commits more than once |
209209

210-
#### Custom issue patterns
210+
### Custom issue patterns
211211

212212
By default, `auto-changelog` will parse [GitHub-style issue fixes](https://help.github.com/articles/closing-issues-using-keywords/) in your commit messages. If you use Jira or an alternative pattern in your commits to reference issues, you can pass in a custom regular expression to `--issue-pattern` along with `--issue-url`:
213213

@@ -235,7 +235,7 @@ If you use a certain pattern before or after the issue number, like `fixes {id}`
235235
auto-changelog --issue-pattern "[Ff]ixes ([A-Z]+-\d+)"
236236
```
237237

238-
#### Replacing text
238+
### Replacing text
239239

240240
To insert links or other markup to PR titles and commit messages that appear in the log, use the `replaceText` option in your `package.json`:
241241

0 commit comments

Comments
 (0)