Skip to content

Commit 49b51e9

Browse files
committed
readme linting task & configuration
1 parent 59a5e68 commit 49b51e9

File tree

3 files changed

+10
-2
lines changed

3 files changed

+10
-2
lines changed

.markdownlintrc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"default": true,
3+
"MD018": true,
4+
"MD003": { "style": "atx" }
5+
}

_config.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ port: 4001
2828
exclude:
2929
- .idea/
3030
- .gitignore
31+
- node_modules
3132
# these are the files and directories that jekyll will exclude from the build
3233

3334
feedback_email: [email protected]

package.json

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,15 @@
33
"version": "1.0.0",
44
"description": "This file: Node-dependant workflow scripts for the jekyll-based site",
55
"scripts": {
6-
"fetch-readmes": "get-readmes --repos=./_data --out=./_includes/readmes"
6+
"fetch-readmes": "get-readmes --repos=./_data --out=./_includes/readmes",
7+
"lint-readmes" : "markdownlint _includes/readmes/"
78
},
89
"repository": {
910
"type": "git",
1011
"url": "git+https://github.com/Strongloop/loopback.io.git"
1112
},
1213
"devDependencies": {
13-
"getreadmes": "github:strongloop/get-readmes"
14+
"getreadmes": "github:strongloop/get-readmes",
15+
"markdownlint-cli": "github:sequoia/markdownlint-cli"
1416
}
1517
}

0 commit comments

Comments
 (0)