Skip to content

Commit

Permalink
feat(CI): add a GitHub Action to lint the Markdown
Browse files Browse the repository at this point in the history
Add a `.markdownlint.yml` config file
  • Loading branch information
jbampton committed Dec 15, 2020
1 parent 6eb76b5 commit 13ac79a
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 0 deletions.
11 changes: 11 additions & 0 deletions .github/workflows/lint-checker.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,14 @@ jobs:
echo $diffs
exit 1
fi
markdownlint:
name: 🍇 Markdown
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: 🚀 Use Node.js
uses: actions/setup-node@v1
with:
node-version: '12.x'
- run: npm install -g markdownlint-cli@0.25.0
- run: markdownlint '**/*.md' --ignore node_modules
14 changes: 14 additions & 0 deletions .markdownlint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# MD004/ul-style Unordered list style
MD004: false

# MD013 Line length
MD013: false

#MD029/ol-prefix Ordered list item prefix
MD029: false

# MD033 Inline HTML
MD033: false

# MD036/no-emphasis-as-heading/no-emphasis-as-header Emphasis used instead of a heading
MD036: false

0 comments on commit 13ac79a

Please sign in to comment.