-
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
5 changed files
with
79 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
{ | ||
"Exclude": [ | ||
".git" | ||
] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
# EditorConfig is awesome: https://EditorConfig.org | ||
|
||
[*] | ||
# Ensure consistent file encoding in UNIX style | ||
charset = utf-8 | ||
end_of_line = lf |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
# Generic checks to ease collaboration: | ||
# - consistent file encoding in UNIX style | ||
# - whitespaces in all purposes files like markdown, yaml, etc | ||
name: Check Generic | ||
|
||
on: | ||
push: | ||
branches: | ||
- main | ||
pull_request: | ||
branches: | ||
- main | ||
|
||
jobs: | ||
editorconfig-checker: | ||
name: Run editorconfig-checker | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Checkout | ||
uses: actions/checkout@v4 | ||
- name: Install editorconfig-checker | ||
run: pipx install "editorconfig-checker" | ||
- name: Run editorconfig-checker | ||
run: ec . | ||
|
||
markdownlint: | ||
name: Run markdownlint | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Checkout | ||
uses: actions/checkout@v4 | ||
- name: Run markdownlint-cli2 | ||
uses: DavidAnson/markdownlint-cli2-action@v13 | ||
|
||
yamllint: | ||
name: Run yamllint | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Checkout | ||
uses: actions/checkout@v4 | ||
- name: Run yamllint | ||
run: yamllint . |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
# Disable some built-in rules | ||
config: | ||
line-length: false | ||
no-inline-html: false | ||
first-line-h1: false | ||
code-block-style: false # conflicts with MkDocs Admontions: https://squidfunk.github.io/mkdocs-material/reference/admonitions/ | ||
code-fence-style: | ||
style: backtick | ||
|
||
# Define glob expressions to use (only valid at root) | ||
globs: | ||
- "**/*.md" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
extends: default | ||
|
||
rules: | ||
document-start: disable | ||
indentation: | ||
spaces: 2 | ||
line-length: disable | ||
quoted-strings: | ||
quote-type: double | ||
required: only-when-needed | ||
allow-quoted-quotes: true | ||
check-keys: true | ||
truthy: | ||
check-keys: false |