mirror of
https://github.com/sigp/lighthouse.git
synced 2026-03-14 18:32:42 +00:00
3070cb7c39
* linter * Add markdown linter * add env * only check markdown * Add token * Update .github/workflows/test-suite.yml * Markdown linter * Exit code * Update script * rename * mdlint * Add an empty line after end of file * Testing disable * add text * update mdlint.sh * ori validator inclusion * Add config yml file * Remove MD041 and fix advanced-datadir file * FIx validator inclusion file conflict * Merge branch 'unstable' into markdown-linter * change files * Merge branch 'markdown-linter' of https://github.com/chong-he/lighthouse into markdown-linter * mdlint * Remove MD025 * Remove MD036 * Remove MD045 * Removr MD001 * Set MD028 to false * Remove MD024 * Remove MD055 * Remove MD029 * Remove MD040 * Set MD040 to false * Set MD033 to false * Set MD013 to false * Rearrange yml file * Update mdlint.sh and test * Test remove fix * Test with fix * Test with space * Fix summary indentation * Test mdlint.sh * Update mdlint.sh * Test * Update * Test fix * Test again * Fix * merge into check-code * Update scripts/mdlint.sh Co-authored-by: Mac L <mjladson@pm.me> * Update scripts/mdlint.sh Co-authored-by: Mac L <mjladson@pm.me> * Remove set -e * Add comment * Merge pull request #7 from chong-he/unstable Merge unstable to markdown branch * mdlint * Merge branch 'unstable' into markdown-linter * mdlint
28 lines
1.4 KiB
YAML
28 lines
1.4 KiB
YAML
# MD010: https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md010---hard-tabs
|
|
MD010:
|
|
# Set code blocks to false so that code blocks will be ignored, default is true
|
|
code_blocks: false
|
|
|
|
#MD013 line length: https://github.com/DavidAnson/markdownlint/blob/main/doc/md013.md
|
|
# Set to false as this will also interfere with help_x.md files, and it is not necessary to comply with the line length of 80
|
|
MD013: false
|
|
|
|
# MD028: set to false to allow blank line between blockquote: https://github.com/DavidAnson/markdownlint/blob/main/doc/md028.md
|
|
# This is because the blockquotes are shown separatedly (a deisred outcome) when having a blank line in between
|
|
MD028: false
|
|
|
|
# MD024: set siblings_only to true so that same headings with different parent headings are allowed
|
|
# https://github.com/DavidAnson/markdownlint/blob/main/doc/md024.md
|
|
MD024:
|
|
siblings_only: true
|
|
|
|
# MD033 in-line html: https://github.com/DavidAnson/markdownlint/blob/main/doc/md033.md
|
|
# In-line html is fine in the markdown files, so this is set to false
|
|
MD033: false
|
|
|
|
# MD036 set to false to preserve the emphasis on deprecation notice on key-management.md (a heading is not necessary)
|
|
MD036: false
|
|
|
|
# MD040 code blocks should have a language specified: https://github.com/DavidAnson/markdownlint/blob/main/doc/md040.md
|
|
# Set to false as the help_x.md files are code blocks without a language specified, which is fine and does not need to change
|
|
MD040: false |