Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: add linter for markdown documents #3133

Merged
merged 9 commits into from
Feb 13, 2023
Merged

docs: add linter for markdown documents #3133

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
5d7627c
markdown lint
crodriguezvega Feb 9, 2023
3ee6e1f
linting and alignemnt
crodriguezvega Feb 9, 2023
a1ab04c
make command and config for markdown linting
crodriguezvega Feb 9, 2023
4eda084
review comments
crodriguezvega Feb 10, 2023
653f767
alignment
crodriguezvega Feb 10, 2023
deb2dff
Merge branch 'main' into carlos/markdown-lint
crodriguezvega Feb 13, 2023
8826db5
Update .markdownlintignore
crodriguezvega Feb 13, 2023
59e90ce
fix alignment
crodriguezvega Feb 13, 2023
eeed45e
Merge branch 'carlos/markdown-lint' of https://github.com/cosmos/ibc-…
crodriguezvega Feb 13, 2023
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
Prev Previous commit
Next Next commit
make command and config for markdown linting
  • Loading branch information
@crodriguezvega
crodriguezvega committed Feb 9, 2023
commit a1ab04c527f0c82c51c2f081dc7b529b96a9d2af
10 changes: 10 additions & 0 deletions .markdownlint.jsonc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"default": true,
"MD013": false, // https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md013---line-length
"MD024": false, // https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md024---multiple-headings-with-the-same-content
"MD025": false, // https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md025---multiple-top-level-headings-in-the-same-document
"MD029": false, // https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md029---ordered-list-item-prefix
"MD033": false, // https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md033---inline-html
"MD036": false, // https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md036---emphasis-used-instead-of-a-heading
"MD041": false // https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md041---first-line-in-a-file-should-be-a-top-level-heading
}
4 changes: 4 additions & 0 deletions .markdownlintignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
vendor
e2e/vendor
docs/node_modules
docs/ibc/proto-docs.md
3 changes: 3 additions & 0 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -302,6 +302,9 @@ format:
find . -name '*.go' -type f -not -path "./vendor*" -not -path "*.git*" -not -path "./docs/client/statik/statik.go" -not -path "./tests/mocks/*" -not -name '*.pb.go' -not -name '*.pb.gw.go' | xargs misspell -w
.PHONY: format

docs-lint:
markdownlint . --fix

###############################################################################
### Protobuf ###
###############################################################################
Expand Down