Skip to content

Commit bf3eb91

Browse files
ci: scope docs workflow linting
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
1 parent f4fc1ca commit bf3eb91

2 files changed

Lines changed: 29 additions & 0 deletions

File tree

.github/workflows/Docs.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,8 @@ jobs:
4848
GITHUB_TOKEN: ${{ github.token }}
4949
ENABLE_GITHUB_ACTIONS_STEP_SUMMARY: true
5050
ENABLE_GITHUB_PULL_REQUEST_SUMMARY_COMMENT: true
51+
FILTER_REGEX_INCLUDE: '.*(docs/.*|\.github/actions/update-index/.*|\.github/workflows/Docs\.yml)$'
52+
MARKDOWN_CONFIG_FILE: docs/.markdown-lint.yml
5153
SAVE_SUPER_LINTER_SUMMARY: true
5254
VALIDATE_BIOME_LINT: false
5355
VALIDATE_BIOME_FORMAT: false

docs/.markdown-lint.yml

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
###########################
2+
## Markdown Linter rules ##
3+
###########################
4+
5+
# Linter rules doc:
6+
# - https://github.com/DavidAnson/markdownlint
7+
8+
###############
9+
# Rules by id #
10+
###############
11+
MD004: false # Unordered list style
12+
MD007:
13+
indent: 2 # Unordered list indentation
14+
MD013:
15+
line_length: 3000 # Line length
16+
MD025: false # Allow front-matter title + visible H1 on docs pages
17+
MD026:
18+
punctuation: '.,;:!。,;:' # List of not allowed
19+
MD029: false # Ordered list item prefix
20+
MD033: false # Allow inline HTML
21+
MD036: false # Emphasis used instead of a heading
22+
MD041: false # First line in file should be a top level heading, PULL_REQUEST_TEMPLATE.md is an exception
23+
24+
#################
25+
# Rules by tags #
26+
#################
27+
blank_lines: false # Error on blank lines

0 commit comments

Comments
 (0)