Skip to content

Commit

Permalink
pre-commit - move hook from markdownlint to markdownlint-cli2
Browse files Browse the repository at this point in the history
fix a few minor markdown issues found by the new hook.
  • Loading branch information
winterz committed Sep 9, 2024
1 parent 753c522 commit a7b03b4
Show file tree
Hide file tree
Showing 8 changed files with 26 additions and 16 deletions.
1 change: 1 addition & 0 deletions .krazy
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,4 @@ SKIP Doxyfile.cmake
SKIP \.cmake-format\.py
#skip the borrowed code in the cmake subdir
SKIP /cmake/ECM/|/cmake/KDAB/
SKIP .markdownlint.json
16 changes: 16 additions & 0 deletions .markdownlint.json
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.

6 changes: 2 additions & 4 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -45,12 +45,10 @@ repos:
exclude: (.py.cmake|Doxyfile.cmake)
- id: cmake-format
exclude: (.py.cmake|Doxyfile.cmake)
- repo: https://github.com/markdownlint/markdownlint
- repo: https://github.com/DavidAnson/markdownlint-cli2
rev: v0.12.0
hooks:
- id: markdownlint
entry: mdl
language: ruby
- id: markdownlint-cli2
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 @@ -19,7 +19,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.py .clang-format .clang-tidy .clazy .gitignore .mdlrc .mdlrc.rb .pep8 .pylintrc .editorconfig .shellcheck docs/api/Doxyfile.cmake distro/*
Files: .pre-commit-config.yaml .codespellrc .krazy .cmake-format.py .clang-format .clang-tidy .clazy .gitignore .markdownlint.json .pep8 .pylintrc .editorconfig .shellcheck docs/api/Doxyfile.cmake distro/*
Copyright: Klarälvdalens Datakonsult AB, a KDAB Group company <[email protected]>
License: BSD-3-Clause

Expand Down
1 change: 1 addition & 0 deletions README-bindings.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ except installing `shiboken6 pyside6 shiboken6_generator` with pip3.
## Building KDReports Python Bindings

Tell CMake to build the bindings by passing the `-DKDReports_PYTHON_BINDINGS=True' option.

Then run `cmake --build` as usual.

The bindings will be installed to `CMAKE_INSTALL_PREFIX`, which might require setting
Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Introduction

<div>
<img src="images/kdreports-trademark.png" width="68%"/>
<img src="images/kdreports.png" height="200px"/>
<img src="images/kdreports-trademark.png" width="68%" alt="<kdreports-trademark>"/>
<img src="images/kdreports.png" height="200px" alt="<kdreports-logo>" />
</div>

# Introduction

KD Reports is a Qt tool that lets you easily create printable reports by
providing all of the necessary features for a variety of applications.
Reports can be created programmatically, using an easy to use C++ API, or they
Expand Down Expand Up @@ -42,7 +42,7 @@ The starting point for using KD Reports is the KDReports::Report class.

* See our official home page: <https://www.kdab.com/development-resources/qt-tools/kd-reports>
* Visit us on GitHub: <https://github.com/KDAB/KDReports>
* Email [email protected] for questions about this product.
* Email <[email protected]> for questions about this product.

Stay up-to-date with KDAB product announcements:

Expand Down

0 comments on commit a7b03b4

Please sign in to comment.