Skip to content

Commit

Permalink
build(pre-commit): Add markdownlint
Browse files Browse the repository at this point in the history
  • Loading branch information
trallnag committed Mar 25, 2023
1 parent 7d0d9bb commit b2fd462
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 2 deletions.
16 changes: 16 additions & 0 deletions .markdownlint.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Default state for all rules.
default: true

# MD024/no-duplicate-heading/no-duplicate-header - Multiple headings with the same content.
MD024:
# Only check sibling headings.
siblings_only: true

# MD013/line-length: Line length.
MD013: false

# MD041/first-line-heading/first-line-h1: First line in a file should be a top-level heading.
MD041: false

# MD040/fenced-code-language Fenced code blocks should have a language specified
MD040: false
5 changes: 5 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,11 @@ repos:
- id: mdformat
args: [--wrap=80]

- repo: https://github.com/DavidAnson/markdownlint-cli2
rev: v0.6.0
hooks:
- id: markdownlint-cli2

- repo: https://github.com/pre-commit/mirrors-prettier
rev: v3.0.0-alpha.6
hooks:
Expand Down
4 changes: 2 additions & 2 deletions devel/pre-commit.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,11 @@ Pre-commit is configured via
## GitHub Actions

While pre-commit is used in GitHub Actions, there is no explicit job or workflow
where pre-commit is executed. This happens through https://pre-commit.ci a
where pre-commit is executed. This happens through <https://pre-commit.ci> a
GitHub App called [pre-commit ci](https://github.com/marketplace/pre-commit-ci).

Configuration for this is done in the repository owner's settings and the
https://pre-commit.ci web user interface.
<https://pre-commit.ci> web user interface.

## Housekeeping

Expand Down

0 comments on commit b2fd462

Please sign in to comment.