Skip to content

Commit

Permalink
Document .hallmarkrc and changelog options
Browse files Browse the repository at this point in the history
  • Loading branch information
vweevers committed Oct 31, 2020
1 parent 9e2b53b commit fe50723
Showing 1 changed file with 18 additions and 2 deletions.
20 changes: 18 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
- [Usage](#usage)
- [Package Options](#package-options)
- [`ignore`](#ignore)
- [`changelog`](#changelog)
- [`validateLinks`](#validatelinks)
- [`paddedTable`](#paddedtable)
- [`toc`](#toc)
Expand Down Expand Up @@ -160,16 +161,31 @@ You can add a `hallmark` object to your `package.json` with additional configura
"hallmark": {
"ignore": [
"CONTRIBUTING.md"
],
"validateLinks": false
]
}
}
```

Alternatively, for use in non-node projects, place a `.hallmarkrc` file in the working directory or any of its parent directories:

```json
{
"ignore": [
"CONTRIBUTING.md"
]
}
```

### `ignore`

A string or array of files to ignore. Merged with `--ignore / -i` if any.

### `changelog`

An object containing options to be passed to [`remark-changelog`](https://github.com/vweevers/remark-changelog):

- `submodules` (boolean): enable experimental git submodule support. Will (upon encountering new or empty changelog entries) collect commits from submodules and list them in the changelog as `<submodule>: <message>`.

### `validateLinks`

Boolean. Set to `false` to skip validating links. Useful when a markdown file uses HTML anchors, which not are not recognized as links. A temporary option until we decide whether to allow and parse those.
Expand Down

0 comments on commit fe50723

Please sign in to comment.