Skip to content

Commit 03638f5

Browse files
committed
Install markdownlint VSCode extension, CLI and github config
cf https://github.com/github/markdownlint-github
1 parent 35cb113 commit 03638f5

4 files changed

Lines changed: 551 additions & 0 deletions

File tree

.markdownlint-cli2.cjs

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
const options = require('@github/markdownlint-github').init()
2+
module.exports = {
3+
config: options,
4+
customRules: ["@github/markdownlint-github"],
5+
outputFormatters: [
6+
[ "markdownlint-cli2-formatter-pretty", { "appendLink": true } ] // ensures the error message includes a link to the rule documentation
7+
]
8+
}

.vscode/extensions.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
// List of extensions which should be recommended for users of this workspace.
55
"recommendations": [
66
"amodio.tsl-problem-matcher",
7+
"DavidAnson.vscode-markdownlint",
78
"dbaeumer.vscode-eslint",
89
"esbenp.prettier-vscode",
910
"firsttris.vscode-jest-runner",

0 commit comments

Comments
 (0)