|
2 | 2 | "$schema": "node_modules/markdownlint-cli2/schema/markdownlint-cli2-config-schema.json",
|
3 | 3 | "gitignore": true,
|
4 | 4 | "globs": ["**/*.md"],
|
5 |
| - "ignores": ["node_modules", "coverage", "lib", "CHANGELOG.md"], |
| 5 | + "ignores": ["node_modules", "coverage", "dist", "CHANGELOG.md"], |
| 6 | + "config": { |
| 7 | + "default": false, |
| 8 | + "extends": "markdownlint/style/prettier", |
| 9 | + |
| 10 | + // MD001/heading-increment : Heading levels should only increment by one level at a time : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md001.md |
| 11 | + "MD001": true, |
| 12 | + |
| 13 | + // MD003/heading-style : Heading style : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md003.md |
| 14 | + "MD003": { |
| 15 | + // Heading style |
| 16 | + "style": "atx", |
| 17 | + }, |
| 18 | + |
| 19 | + // MD004/ul-style : Unordered list style : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md004.md |
| 20 | + "MD004": { |
| 21 | + // List style |
| 22 | + "style": "dash", |
| 23 | + }, |
| 24 | + |
| 25 | + // MD005/list-indent : Inconsistent indentation for list items at the same level : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md005.md |
| 26 | + "MD005": true, |
| 27 | + |
| 28 | + // MD007/ul-indent : Unordered list indentation : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md007.md |
| 29 | + "MD007": { |
| 30 | + // Spaces for indent |
| 31 | + "indent": 2, |
| 32 | + // Whether to indent the first level of the list |
| 33 | + "start_indented": false, |
| 34 | + // Spaces for first level indent (when start_indented is set) |
| 35 | + "start_indent": 2, |
| 36 | + }, |
| 37 | + |
| 38 | + // MD009/no-trailing-spaces : Trailing spaces : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md009.md |
| 39 | + "MD009": { |
| 40 | + // Spaces for line break - 0 to disable |
| 41 | + "br_spaces": 0, |
| 42 | + // Allow spaces for empty lines in list items |
| 43 | + "list_item_empty_lines": false, |
| 44 | + // Include unnecessary breaks |
| 45 | + "strict": false, |
| 46 | + }, |
| 47 | + |
| 48 | + // MD010/no-hard-tabs : Hard tabs : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md010.md |
| 49 | + "MD010": { |
| 50 | + // Include code blocks |
| 51 | + "code_blocks": true, |
| 52 | + // Fenced code languages to ignore |
| 53 | + "ignore_code_languages": [], |
| 54 | + // Number of spaces for each hard tab |
| 55 | + "spaces_per_tab": 2, |
| 56 | + }, |
| 57 | + |
| 58 | + // MD011/no-reversed-links : Reversed link syntax : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md011.md |
| 59 | + "MD011": true, |
| 60 | + |
| 61 | + // MD012/no-multiple-blanks : Multiple consecutive blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md012.md |
| 62 | + "MD012": { |
| 63 | + // Consecutive blank lines |
| 64 | + "maximum": 1, |
| 65 | + }, |
| 66 | + |
| 67 | + // MD013/line-length : Line length : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md013.md |
| 68 | + "MD013": { |
| 69 | + // Number of characters |
| 70 | + "line_length": 120, |
| 71 | + // Number of characters for headings |
| 72 | + "heading_line_length": 120, |
| 73 | + // Number of characters for code blocks |
| 74 | + "code_block_line_length": 120, |
| 75 | + // Include code blocks |
| 76 | + "code_blocks": true, |
| 77 | + // Include tables |
| 78 | + "tables": false, |
| 79 | + // Include headings |
| 80 | + "headings": true, |
| 81 | + // Strict length checking |
| 82 | + "strict": false, |
| 83 | + // Stern length checking |
| 84 | + "stern": false, |
| 85 | + }, |
| 86 | + |
| 87 | + // MD014/commands-show-output : Dollar signs used before commands without showing output : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md014.md |
| 88 | + // "MD014": true, |
| 89 | + |
| 90 | + // MD018/no-missing-space-atx : No space after hash on atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md018.md |
| 91 | + "MD018": true, |
| 92 | + |
| 93 | + // MD019/no-multiple-space-atx : Multiple spaces after hash on atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md019.md |
| 94 | + "MD019": true, |
| 95 | + |
| 96 | + // MD020/no-missing-space-closed-atx : No space inside hashes on closed atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md020.md |
| 97 | + "MD020": true, |
| 98 | + |
| 99 | + // MD021/no-multiple-space-closed-atx : Multiple spaces inside hashes on closed atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md021.md |
| 100 | + "MD021": true, |
| 101 | + |
| 102 | + // MD022/blanks-around-headings : Headings should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md022.md |
| 103 | + "MD022": { |
| 104 | + // Blank lines above heading |
| 105 | + "lines_above": 1, |
| 106 | + // Blank lines below heading |
| 107 | + "lines_below": 1, |
| 108 | + }, |
| 109 | + |
| 110 | + // MD023/heading-start-left : Headings must start at the beginning of the line : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md023.md |
| 111 | + "MD023": true, |
| 112 | + |
| 113 | + // MD024/no-duplicate-heading : Multiple headings with the same content : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md024.md |
| 114 | + "MD024": { |
| 115 | + // Only check sibling headings |
| 116 | + "siblings_only": true, |
| 117 | + }, |
| 118 | + |
| 119 | + // MD025/single-title/single-h1 : Multiple top-level headings in the same document : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md025.md |
| 120 | + "MD025": { |
| 121 | + // Heading level |
| 122 | + "level": 1, |
| 123 | + // RegExp for matching title in front matter |
| 124 | + "front_matter_title": "^\\s*title\\s*[:=]", |
| 125 | + }, |
| 126 | + |
| 127 | + // MD026/no-trailing-punctuation : Trailing punctuation in heading : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md026.md |
| 128 | + "MD026": { |
| 129 | + // Punctuation characters |
| 130 | + "punctuation": ".,;:!。,;:!", |
| 131 | + }, |
| 132 | + |
| 133 | + // MD027/no-multiple-space-blockquote : Multiple spaces after blockquote symbol : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md027.md |
| 134 | + "MD027": true, |
| 135 | + |
| 136 | + // MD028/no-blanks-blockquote : Blank line inside blockquote : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md028.md |
| 137 | + "MD028": true, |
| 138 | + |
| 139 | + // MD029/ol-prefix : Ordered list item prefix : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md029.md |
| 140 | + "MD029": { |
| 141 | + // List style |
| 142 | + "style": "one_or_ordered", |
| 143 | + }, |
| 144 | + |
| 145 | + // MD030/list-marker-space : Spaces after list markers : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md030.md |
| 146 | + "MD030": { |
| 147 | + // Spaces for single-line unordered list items |
| 148 | + "ul_single": 1, |
| 149 | + // Spaces for single-line ordered list items |
| 150 | + "ol_single": 1, |
| 151 | + // Spaces for multi-line unordered list items |
| 152 | + "ul_multi": 1, |
| 153 | + // Spaces for multi-line ordered list items |
| 154 | + "ol_multi": 1, |
| 155 | + }, |
| 156 | + |
| 157 | + // MD031/blanks-around-fences : Fenced code blocks should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md031.md |
| 158 | + "MD031": { |
| 159 | + // Include list items |
| 160 | + "list_items": true, |
| 161 | + }, |
| 162 | + |
| 163 | + // MD032/blanks-around-lists : Lists should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md032.md |
| 164 | + "MD032": true, |
| 165 | + |
| 166 | + // MD033/no-inline-html : Inline HTML : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md033.md |
| 167 | + // "MD033": { |
| 168 | + // // Allowed elements |
| 169 | + // "allowed_elements": ["details", "summary", "sub", "sup", "img"] |
| 170 | + // }, |
| 171 | + |
| 172 | + // MD034/no-bare-urls : Bare URL used : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md034.md |
| 173 | + "MD034": true, |
| 174 | + |
| 175 | + // MD035/hr-style : Horizontal rule style : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md035.md |
| 176 | + "MD035": { |
| 177 | + // Horizontal rule style |
| 178 | + "style": "---", |
| 179 | + }, |
| 180 | + |
| 181 | + // MD036/no-emphasis-as-heading : Emphasis used instead of a heading : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md036.md |
| 182 | + "MD036": { |
| 183 | + // Punctuation characters |
| 184 | + "punctuation": ".,;:!?。,;:!?", |
| 185 | + }, |
| 186 | + |
| 187 | + // MD037/no-space-in-emphasis : Spaces inside emphasis markers : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md037.md |
| 188 | + "MD037": true, |
| 189 | + |
| 190 | + // MD038/no-space-in-code : Spaces inside code span elements : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md038.md |
| 191 | + "MD038": true, |
| 192 | + |
| 193 | + // MD039/no-space-in-links : Spaces inside link text : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md039.md |
| 194 | + "MD039": true, |
| 195 | + |
| 196 | + // MD040/fenced-code-language : Fenced code blocks should have a language specified : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md040.md |
| 197 | + "MD040": { |
| 198 | + // List of languages |
| 199 | + "allowed_languages": [], |
| 200 | + // Require language only |
| 201 | + "language_only": false, |
| 202 | + }, |
| 203 | + |
| 204 | + // MD041/first-line-heading/first-line-h1 : First line in a file should be a top-level heading : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md041.md |
| 205 | + // "MD041": { |
| 206 | + // // Heading level |
| 207 | + // "level": 1, |
| 208 | + // // RegExp for matching title in front matter |
| 209 | + // "front_matter_title": "^\\s*title\\s*[:=]" |
| 210 | + // }, |
| 211 | + |
| 212 | + // MD042/no-empty-links : No empty links : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md042.md |
| 213 | + "MD042": true, |
| 214 | + |
| 215 | + // MD043/required-headings : Required heading structure : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md043.md |
| 216 | + // "MD043": { |
| 217 | + // // List of headings |
| 218 | + // "headings": [], |
| 219 | + // // Match case of headings |
| 220 | + // "match_case": false |
| 221 | + // }, |
| 222 | + |
| 223 | + // MD044/proper-names : Proper names should have the correct capitalization : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md044.md |
| 224 | + // "MD044": { |
| 225 | + // // List of proper names |
| 226 | + // "names": [], |
| 227 | + // // Include code blocks |
| 228 | + // "code_blocks": true, |
| 229 | + // // Include HTML elements |
| 230 | + // "html_elements": true |
| 231 | + // }, |
| 232 | + |
| 233 | + // MD045/no-alt-text : Images should have alternate text (alt text) : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md045.md |
| 234 | + "MD045": true, |
| 235 | + |
| 236 | + // MD046/code-block-style : Code block style : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md046.md |
| 237 | + "MD046": { |
| 238 | + // Block style |
| 239 | + "style": "fenced", |
| 240 | + }, |
| 241 | + |
| 242 | + // MD047/single-trailing-newline : Files should end with a single newline character : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md047.md |
| 243 | + "MD047": true, |
| 244 | + |
| 245 | + // MD048/code-fence-style : Code fence style : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md048.md |
| 246 | + "MD048": { |
| 247 | + // Code fence style |
| 248 | + "style": "backtick", |
| 249 | + }, |
| 250 | + |
| 251 | + // MD049/emphasis-style : Emphasis style : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md049.md |
| 252 | + "MD049": { |
| 253 | + // Emphasis style |
| 254 | + "style": "underscore", |
| 255 | + }, |
| 256 | + |
| 257 | + // MD050/strong-style : Strong style : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md050.md |
| 258 | + "MD050": { |
| 259 | + // Strong style |
| 260 | + "style": "asterisk", |
| 261 | + }, |
| 262 | + |
| 263 | + // MD051/link-fragments : Link fragments should be valid : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md051.md |
| 264 | + "MD051": true, |
| 265 | + |
| 266 | + // MD052/reference-links-images : Reference links and images should use a label that is defined : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md052.md |
| 267 | + "MD052": { |
| 268 | + // Include shortcut syntax |
| 269 | + "shortcut_syntax": false, |
| 270 | + }, |
| 271 | + |
| 272 | + // MD053/link-image-reference-definitions : Link and image reference definitions should be needed : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md053.md |
| 273 | + "MD053": { |
| 274 | + // Ignored definitions |
| 275 | + "ignored_definitions": ["//"], |
| 276 | + }, |
| 277 | + |
| 278 | + // MD054/link-image-style : Link and image style : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md054.md |
| 279 | + "MD054": { |
| 280 | + // Allow autolinks |
| 281 | + "autolink": true, |
| 282 | + // Allow inline links and images |
| 283 | + "inline": true, |
| 284 | + // Allow full reference links and images |
| 285 | + "full": true, |
| 286 | + // Allow collapsed reference links and images |
| 287 | + "collapsed": true, |
| 288 | + // Allow shortcut reference links and images |
| 289 | + "shortcut": true, |
| 290 | + // Allow URLs as inline links |
| 291 | + "url_inline": true, |
| 292 | + }, |
| 293 | + |
| 294 | + // MD055/table-pipe-style : Table pipe style : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md055.md |
| 295 | + "MD055": { |
| 296 | + // Table pipe style |
| 297 | + "style": "leading_and_trailing", |
| 298 | + }, |
| 299 | + |
| 300 | + // MD056/table-column-count : Table column count : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md056.md |
| 301 | + "MD056": true, |
| 302 | + }, |
6 | 303 | }
|
0 commit comments