Skip to content

Commit

Permalink
Switch pre-commit to markdownlint-cli2 (#33)
Browse files Browse the repository at this point in the history
* Switch pre-commit to markdownlint-cli2

It doesn't require Ruby and works out of the box on Windows. Original
markdownlint wasn't able to install Ruby properly on Windows.

* Fix links in README

As found by new markdownlint config.
  • Loading branch information
MiKom authored Aug 27, 2024
1 parent db9c4ab commit 8be30ff
Show file tree
Hide file tree
Showing 6 changed files with 22 additions and 14 deletions.
16 changes: 16 additions & 0 deletions .markdownlint.jsonc
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{
"default": true,
"MD007": {
"indent": 2,
"start_indented": false
},
"MD013": {
"line_length": 100,
"tables": false,
"code_blocks": false
},
"MD029": {
"style": "ordered"
},
"MD033": false
}
1 change: 0 additions & 1 deletion .mdlrc

This file was deleted.

5 changes: 0 additions & 5 deletions .mdlrc.rb

This file was deleted.

8 changes: 3 additions & 5 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,11 @@ repos:
hooks:
- id: cmake-lint
- id: cmake-format
- repo: https://github.com/markdownlint/markdownlint
rev: v0.12.0
- repo: https://github.com/DavidAnson/markdownlint-cli2
rev: v0.13.0
hooks:
- id: markdownlint
entry: mdl
- id: markdownlint-cli2
exclude: ^(3rdParty/|common/ui/resources/licenses/)
language: ruby
files: \.(md|mdown|markdown)$
- repo: https://github.com/fsfe/reuse-tool
rev: v4.0.3
Expand Down
2 changes: 1 addition & 1 deletion .reuse/dep5
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Copyright: Klarälvdalens Datakonsult AB, a KDAB Group company <[email protected]>
License: MIT

#misc config files
Files: .pre-commit-config.yaml .codespellrc .krazy .cmake-format .clang-format .clang-tidy .gitignore .gitreview .mdlrc .mdlrc.rb appveyor.yml
Files: .pre-commit-config.yaml .codespellrc .krazy .cmake-format .clang-format .clang-tidy .gitignore .gitreview .markdownlint.jsonc appveyor.yml
Copyright: Klarälvdalens Datakonsult AB, a KDAB Group company <[email protected]>
License: BSD-3-Clause

Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ sudo apt install gcovr
## Contact

- Visit us on GitHub: <https://github.com/KDAB/KDUtils>
- Email [email protected] for questions about copyright, licensing or commercial support.
- Email <[email protected]> for questions about copyright, licensing or commercial support.

## Licensing

Expand All @@ -78,7 +78,7 @@ Contact KDAB at <[email protected]> to inquire about commercial licensing.
Please submit your contributions or issue reports from our GitHub space at
<https://github.com/KDAB/KDUtils>.

Contact [email protected] for more information.
Contact <[email protected]> for more information.

## About KDAB

Expand Down

0 comments on commit 8be30ff

Please sign in to comment.