Skip to content

Commit 6d1ffa4

Browse files
janoshshyuep
andauthored
Markdownlint (#3209)
* pre-commit exclude tests/files (prev .*test_files) * add pre-commit hook https://github.com/igorshubovych/markdownlint-cli * auto-format CHANGES.md * auto-fix white space --------- Co-authored-by: Shyue Ping Ong <[email protected]>
1 parent cba013b commit 6d1ffa4

File tree

12 files changed

+1650
-1330
lines changed

12 files changed

+1650
-1330
lines changed

.pre-commit-config.yaml

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
exclude: ^(docs|.*test_files|cmd_line|tasks.py)
1+
exclude: ^(docs|tests/files|cmd_line|tasks.py)
22

33
ci:
44
autoupdate_schedule: monthly
@@ -8,7 +8,7 @@ ci:
88

99
repos:
1010
- repo: https://github.com/astral-sh/ruff-pre-commit
11-
rev: v0.0.281
11+
rev: v0.0.282
1212
hooks:
1313
- id: ruff
1414
args: [--fix]
@@ -45,3 +45,13 @@ repos:
4545
- id: cython-lint
4646
args: [--no-pycodestyle]
4747
- id: double-quote-cython-strings
48+
49+
- repo: https://github.com/igorshubovych/markdownlint-cli
50+
rev: v0.35.0
51+
hooks:
52+
- id: markdownlint
53+
# MD013: line too long
54+
# MD033: no inline HTML
55+
# MD041: first line in a file should be a top-level heading
56+
args: [--disable, MD013, MD033, MD041, "--"]
57+
exclude: ^(CHANGES.md)

CHANGES.md

Lines changed: 1576 additions & 1265 deletions
Large diffs are not rendered by default.

docs/_config.yml

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/_includes/footer_custom.html

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/_includes/nav_footer_custom.html

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/assets/pymatgen.svg

Lines changed: 1 addition & 1 deletion
Loading

docs/assets/team-map.html

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/compatibility.md

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/contributing.md

Lines changed: 7 additions & 7 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)