Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .markdownlintrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"default": true,
"MD018": true,
"MD003": { "style": "atx" }
}
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,3 +66,13 @@ summary: A brief tutorial on creating an Angular client app using the Loopback A

{% include readmes/loopback-example-angular.md %}
```

### Linting Readmes

There is an additional `npm script` that "lints" the readmes for markdown formatting problems. It is currently "experimental", see #49 for more info.

You can run this script thus:

```js
$ npm run lint-readmes
```
1 change: 1 addition & 0 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ port: 4001
exclude:
- .idea/
- .gitignore
- node_modules
# these are the files and directories that jekyll will exclude from the build

feedback_email: [email protected]
Expand Down
6 changes: 4 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,15 @@
"version": "1.0.0",
"description": "This file: Node-dependant workflow scripts for the jekyll-based site",
"scripts": {
"fetch-readmes": "get-readmes --repos=./_data --out=./_includes/readmes"
"fetch-readmes": "get-readmes --repos=./_data --out=./_includes/readmes",
"lint-readmes" : "markdownlint _includes/readmes/"
},
"repository": {
"type": "git",
"url": "git+https://github.com/Strongloop/loopback.io.git"
},
"devDependencies": {
"getreadmes": "github:strongloop/get-readmes"
"getreadmes": "github:strongloop/get-readmes",
"markdownlint-cli": "github:sequoia/markdownlint-cli"
}
}