Skip to content

Commit 6b63b60

Browse files
authored
Add markdown-lint as recommended VS code plugin (#147)
1 parent bc8815b commit 6b63b60

File tree

2 files changed

+6
-1
lines changed

2 files changed

+6
-1
lines changed

.vscode/extensions.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"recommendations": [
3+
"davidanson.vscode-markdownlint"
4+
]
5+
}

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Longer explanation: Head to <https://adr.github.io/madr/#applying-madr-to-your-p
2020
* MADR follows [Semantic Versioning 2.0.0](https://semver.org/) and documents changes in a `CHANGELOG.md` following [keep a changelog 1.0.0](http://keepachangelog.com/en/1.0.0/).
2121
* Issues can be reported at <https://github.com/adr/madr/issues>.
2222
* Suggestions can be contributed via pull requests. MADR offers pre-configured VS Code web environment at [Gitpod](https://gitpod.io/#https://github.com/adr/madr).
23-
* Use [markdownlint](https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint)
23+
* MADR uses [markdownlint](https://github.com/DavidAnson/markdownlint) as Linter for Markdown files. Use [markdownlint](https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint) for checking for linting issues in VS Code.
2424
* `template/adr-template.md` is mirrored to `docs/decisions/adr-template`.
2525
However, following YAML front matter is added to make it handled properly by the [Just the Docs Jekyll Template](https://just-the-docs.github.io/just-the-docs/). <!-- markdownlint-disable-next-line MD031 -->
2626
```markdown

0 commit comments

Comments
 (0)