se-codeowners/.markdownlint-cli2.yaml at main · structural-explainability/se-codeowners · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
# ============================================================
# .markdownlint-cli2.yaml (Markdownlint CLI2 configuration)
# ============================================================
# Updated: 2026-06-04
# WHY: Generated and dependency directories are not source content.
# REQ: Markdown lint should check authored Markdown, not virtual
#      environments, dependency trees, build output, or generated docs.

globs:
  - "**/*.md"

ignores:
  - ".lake/**"
  - "**/.lake/**"
  - ".venv/**"
  - "**/.venv/**"
  - "node_modules/**"
  - "**/node_modules/**"
  - "site/**"
  - "**/site/**"
  - "dist/**"
  - "**/dist/**"
  - "build/**"
  - "**/build/**"
  - ".ruff_cache/**"
  - "**/.ruff_cache/**"
  - ".pytest_cache/**"
  - "**/.pytest_cache/**"
  - ".mypy_cache/**"
  - "**/.mypy_cache/**"
  - ".pyright/**"
  - "**/.pyright/**"
  - ".tox/**"
  - "**/.tox/**"
  - ".nox/**"
  - "**/.nox/**"
  - ".uv-cache/**"
  - "**/.uv-cache/**"
  - "htmlcov/**"
  - "**/htmlcov/**"
  - "LICENSE"
  - ".github/CODEOWNERS"

config:
  default: true # WHY: This enables all default rules, which is a good starting point for linting Markdown files.

  MD013:
    line_length: 100
    headings: false # WHY: This allows long headings, which can be necessary for clarity and SEO in Markdown files.
    tables: false # WHY: This allows long table cells, which can be necessary for readability and completeness in Markdown files.
    code_blocks: false # WHY: This allows long lines in code blocks, which can be necessary for readability and completeness in Markdown files.

  MD025: false # WHY: This allows multiple top-level headings, which can be necessary in Markdown files that are not strictly linear documents (e.g., README files, documentation index files).

  MD033:
    allowed_elements:
      - mark # WHY: Mark elements are often used in Markdown files for highlighting, and this allows them without triggering a lint error.
      - meta # WHY: Metadata is often needed in Markdown files, and this allows it without triggering a lint error.
      - link # WHY: Links are common in Markdown files, and this allows them without triggering a lint error.
      - details # WHY: Details elements are often used in Markdown files, and this allows them without triggering a lint error.
      - summary # WHY: Summary elements are often used in Markdown files, and this allows them without triggering a lint error.