Skip to content

Commit

Permalink
Add github action for markdown linting
Browse files Browse the repository at this point in the history
  • Loading branch information
mortent committed Sep 3, 2020
1 parent f8c79d5 commit 2247e48
Show file tree
Hide file tree
Showing 267 changed files with 46,548 additions and 230 deletions.
26 changes: 26 additions & 0 deletions .github/workflows/markdown.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Copyright 2019 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

name: Markdown
on:
pull_request:
branches:
- master
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: xt0rted/markdownlint-problem-matcher@v1
- run: (cd site && npm run lint-check)
5 changes: 1 addition & 4 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -80,10 +80,7 @@ functions-examples-docker:
docker push gcr.io/kpt-dev/example-functions:v0.1.0

lintdocs:
git clone git@github.com:igorshubovych/markdownlint-cli.git
(cd markdownlint-cli && npm i)
node markdownlint-cli/markdownlint.js --fix site/content || true
rm -rf markdownlint-cli
(cd site && npm run lint-fix)

gencatalog:
rm site/content/en/guides/consumer/function/catalog/_index.md
Expand Down
9 changes: 9 additions & 0 deletions site/markdownlint.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"default": true,
"MD001": false,
"MD013": false,
"MD024": false,
"MD025": false,
"MD040": false,
"MD046": false
}
1 change: 1 addition & 0 deletions site/node_modules/.bin/markdown-it

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions site/node_modules/.bin/markdownlint

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions site/node_modules/.bin/rc

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

261 changes: 261 additions & 0 deletions site/node_modules/commander/History.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

22 changes: 22 additions & 0 deletions site/node_modules/commander/LICENSE

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 2247e48

Please sign in to comment.