dot/.markdownlint-cli2.jsonc at main · minusfive/dot · 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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
{
  "$schema": "https://raw.githubusercontent.com/DavidAnson/markdownlint-cli2/refs/heads/main/schema/markdownlint-cli2-config-schema.json",
  "fix": false,
  "config": {
    // MD003/heading-style : Heading style should be consistent
    // Enforces ATX style (# Heading) not Setext style
    // https://github.com/DavidAnson/markdownlint/blob/main/doc/md003.md
    "MD003": {
      "style": "atx"
    },

    // MD004/ul-style : Unordered list style - enforce hyphens (-) not asterisks (*)
    // Matches project guideline: "Use hyphens for unordered lists"
    // https://github.com/DavidAnson/markdownlint/blob/main/doc/md004.md
    "MD004": {
      "style": "dash"
    },

    // MD010/no-hard-tabs : Hard tabs
    // Enforces spaces instead of tabs (2 spaces per tab when fixing)
    // https://github.com/DavidAnson/markdownlint/blob/main/doc/md010.md
    "MD010": {
      "spaces_per_tab": 2
    },

    // MD013/line-length : Line length - disabled to allow long lines
    // Project doesn't enforce strict line length limits
    // https://github.com/DavidAnson/markdownlint/blob/main/doc/md013.md
    "MD013": false,

    // MD029/ol-prefix : Ordered list item prefix
    // Enforces sequential numbering (1. 2. 3.) not all 1s
    // Matches guideline: "Sequential numbers for ordered lists"
    // https://github.com/DavidAnson/markdownlint/blob/main/doc/md029.md
    "MD029": {
      "style": "ordered"
    },

    // MD033/no-inline-html : Inline HTML - allow specific HTML elements
    // Permits XML-like tags used in AI tool calls and disclosure widgets
    // https://github.com/DavidAnson/markdownlint/blob/main/doc/md033.md
    "MD033": {
      "allowed_elements": [
        "img",
        "antml:function_calls",
        "antml:invoke",
        "antml:parameter",
        "antml:system_warning",
        "a",
        "summary",
        "details"
      ]
    },

    // MD041/first-line-heading : First line in file should be a top level heading
    // Disabled - not all markdown files need H1 at top (e.g., READMEs with badges)
    // https://github.com/DavidAnson/markdownlint/blob/main/doc/md041.md
    "MD041": false,

    // MD046/code-block-style : Code block style
    // Enforces fenced code blocks (```) over indented code blocks
    // https://github.com/DavidAnson/markdownlint/blob/main/doc/md046.md
    "MD046": {
      "style": "fenced"
    },

    // MD048/code-fence-style : Code fence style
    // Enforces backticks (```) over tildes (~~~) for code fences
    // https://github.com/DavidAnson/markdownlint/blob/main/doc/md048.md
    "MD048": {
      "style": "backtick"
    },

    // MD049/emphasis-style : Emphasis style
    // Enforces underscores (_) for emphasis to differentiate from bold (**)
    // https://github.com/DavidAnson/markdownlint/blob/main/doc/md049.md
    "MD049": {
      "style": "underscore"
    },

    // MD050/strong-style : Strong style
    // Enforces asterisks (**) for bold
    // https://github.com/DavidAnson/markdownlint/blob/main/doc/md050.md
    "MD050": {
      "style": "asterisk"
    },

    // MD052/reference-links-images : Reference links and images should use a label that is defined
    // Ensures reference-style links/images have corresponding definitions
    // Note: shortcut_syntax:false is default, but keeping explicit for clarity
    // https://github.com/DavidAnson/markdownlint/blob/main/doc/md052.md
    "MD052": {
      "shortcut_syntax": false
    },

    // MD055/table-pipe-style : Table pipe style
    // Enforces tables have leading and trailing pipes
    // https://github.com/DavidAnson/markdownlint/blob/main/doc/md055.md
    "MD055": {
      "style": "leading_and_trailing"
    },

    // MD060/table-column-style : Table column style
    // Enforces aligned table columns with proper padding
    // Makes tables more readable in markdown source
    // https://github.com/DavidAnson/markdownlint/blob/main/doc/md060.md
    "MD060": {
      "style": "aligned"
    }
  }
}