Skip to content

Commit

Permalink
ci: add markdown lint
Browse files Browse the repository at this point in the history
  • Loading branch information
dylanhitt committed Jul 3, 2024
1 parent d718140 commit 13b7208
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 1 deletion.
16 changes: 16 additions & 0 deletions .github/workflows/lint.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
name: Lint

on:
pull_request:
push:

jobs:
markdownlint:
runs-on: ubuntu-latest
steps:
- name: markdownlint-cli
uses: nosborn/github-action-markdown-cli@v3.3.0
with:
files: .
config_file: .markdownlint.yaml
dot: true
9 changes: 9 additions & 0 deletions .markdownlint.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
MD001: false

MD010: false

MD013:
code_blocks: false
tables: false

MD033: false
6 changes: 5 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,10 @@ fmt:
lint:
go run github.com/golangci/golangci-lint/cmd/golangci-lint@latest run

lint-markdown:
markdownlint --fix .


example:
( cd examples/full-app-gourmet && go run . -debug )

Expand All @@ -42,5 +46,5 @@ docs:
docs-open:
go run golang.org/x/pkgsite/cmd/pkgsite@latest -http localhost:8084 -open

.PHONY: docs-open docs example-watch example lint fmt ci ci-full
.PHONY: docs-open docs example-watch example lint lint-markdown fmt ci ci-full
.PHONY: dependencies-analyze build bench cover-web cover test

0 comments on commit 13b7208

Please sign in to comment.