|
| 1 | +# Default state for all rules |
| 2 | +default: true |
| 3 | + |
| 4 | +# Path to configuration file to extend |
| 5 | +extends: null |
| 6 | + |
| 7 | +# MD001/heading-increment/header-increment - Heading levels should only increment by one level at a time |
| 8 | +MD001: false |
| 9 | + |
| 10 | +# MD002/first-heading-h1/first-header-h1 - First heading should be a top-level heading |
| 11 | +MD002: |
| 12 | + # Heading level |
| 13 | + level: 1 |
| 14 | + |
| 15 | +# MD003/heading-style/header-style - Heading style |
| 16 | +MD003: |
| 17 | + # Heading style |
| 18 | + style: "consistent" |
| 19 | + |
| 20 | +# MD004/ul-style - Unordered list style |
| 21 | +MD004: |
| 22 | + # List style |
| 23 | + style: "consistent" |
| 24 | + |
| 25 | +# MD005/list-indent - Inconsistent indentation for list items at the same level |
| 26 | +MD005: true |
| 27 | + |
| 28 | +# MD006/ul-start-left - Consider starting bulleted lists at the beginning of the line |
| 29 | +MD006: true |
| 30 | + |
| 31 | +# MD007/ul-indent - Unordered list indentation |
| 32 | +MD007: false |
| 33 | + |
| 34 | +# MD009/no-trailing-spaces - Trailing spaces |
| 35 | +MD009: |
| 36 | + # Spaces for line break |
| 37 | + br_spaces: 2 |
| 38 | + # Allow spaces for empty lines in list items |
| 39 | + list_item_empty_lines: false |
| 40 | + # Include unnecessary breaks |
| 41 | + strict: false |
| 42 | + |
| 43 | +# MD010/no-hard-tabs - Hard tabs |
| 44 | +MD010: |
| 45 | + # Include code blocks |
| 46 | + code_blocks: true |
| 47 | + # Fenced code languages to ignore |
| 48 | + ignore_code_languages: [] |
| 49 | + # Number of spaces for each hard tab |
| 50 | + spaces_per_tab: 1 |
| 51 | + |
| 52 | +# MD011/no-reversed-links - Reversed link syntax |
| 53 | +MD011: true |
| 54 | + |
| 55 | +# MD012/no-multiple-blanks - Multiple consecutive blank lines |
| 56 | +MD012: |
| 57 | + # Consecutive blank lines |
| 58 | + maximum: 1 |
| 59 | + |
| 60 | +# MD013/line-length - Line length |
| 61 | +MD013: false |
| 62 | + |
| 63 | +# MD014/commands-show-output - Dollar signs used before commands without showing output |
| 64 | +MD014: true |
| 65 | + |
| 66 | +# MD018/no-missing-space-atx - No space after hash on atx style heading |
| 67 | +MD018: true |
| 68 | + |
| 69 | +# MD019/no-multiple-space-atx - Multiple spaces after hash on atx style heading |
| 70 | +MD019: true |
| 71 | + |
| 72 | +# MD020/no-missing-space-closed-atx - No space inside hashes on closed atx style heading |
| 73 | +MD020: true |
| 74 | + |
| 75 | +# MD021/no-multiple-space-closed-atx - Multiple spaces inside hashes on closed atx style heading |
| 76 | +MD021: true |
| 77 | + |
| 78 | +# MD022/blanks-around-headings/blanks-around-headers - Headings should be surrounded by blank lines |
| 79 | +MD022: false |
| 80 | + |
| 81 | +# MD023/heading-start-left/header-start-left - Headings must start at the beginning of the line |
| 82 | +MD023: true |
| 83 | + |
| 84 | +# MD024/no-duplicate-heading/no-duplicate-header - Multiple headings with the same content |
| 85 | +MD024: false |
| 86 | + |
| 87 | +# MD025/single-title/single-h1 - Multiple top-level headings in the same document |
| 88 | +MD025: false |
| 89 | + |
| 90 | +# MD026/no-trailing-punctuation - Trailing punctuation in heading |
| 91 | +MD026: |
| 92 | + # Punctuation characters |
| 93 | + punctuation: ".,;:!。,;:!" |
| 94 | + |
| 95 | +# MD027/no-multiple-space-blockquote - Multiple spaces after blockquote symbol |
| 96 | +MD027: true |
| 97 | + |
| 98 | +# MD028/no-blanks-blockquote - Blank line inside blockquote |
| 99 | +MD028: true |
| 100 | + |
| 101 | +# MD029/ol-prefix - Ordered list item prefix |
| 102 | +MD029: false |
| 103 | + |
| 104 | +# MD030/list-marker-space - Spaces after list markers |
| 105 | +MD030: false |
| 106 | + |
| 107 | +# MD031/blanks-around-fences - Fenced code blocks should be surrounded by blank lines |
| 108 | +MD031: |
| 109 | + # Include list items |
| 110 | + list_items: true |
| 111 | + |
| 112 | +# MD032/blanks-around-lists - Lists should be surrounded by blank lines |
| 113 | +MD032: true |
| 114 | + |
| 115 | +# MD033/no-inline-html - Inline HTML |
| 116 | +MD033: false |
| 117 | + |
| 118 | +# MD034/no-bare-urls - Bare URL used |
| 119 | +MD034: true |
| 120 | + |
| 121 | +# MD035/hr-style - Horizontal rule style |
| 122 | +MD035: |
| 123 | + # Horizontal rule style |
| 124 | + style: "consistent" |
| 125 | + |
| 126 | +# MD036/no-emphasis-as-heading/no-emphasis-as-header - Emphasis used instead of a heading |
| 127 | +MD036: false |
| 128 | + # Punctuation characters |
| 129 | + # punctuation: ".,;:!?。,;:!?" |
| 130 | + |
| 131 | +# MD037/no-space-in-emphasis - Spaces inside emphasis markers |
| 132 | +MD037: true |
| 133 | + |
| 134 | +# MD038/no-space-in-code - Spaces inside code span elements |
| 135 | +MD038: true |
| 136 | + |
| 137 | +# MD039/no-space-in-links - Spaces inside link text |
| 138 | +MD039: true |
| 139 | + |
| 140 | +# MD040/fenced-code-language - Fenced code blocks should have a language specified |
| 141 | +MD040: false |
| 142 | + |
| 143 | +# MD041/first-line-heading/first-line-h1 - First line in a file should be a top-level heading |
| 144 | +MD041: |
| 145 | + # Heading level |
| 146 | + level: 1 |
| 147 | + # RegExp for matching title in front matter |
| 148 | + front_matter_title: "^\\s*title\\s*[:=]" |
| 149 | + |
| 150 | +# MD042/no-empty-links - No empty links |
| 151 | +MD042: true |
| 152 | + |
| 153 | +# MD043/required-headings/required-headers - Required heading structure |
| 154 | +MD043: false |
| 155 | + |
| 156 | +# MD044/proper-names - Proper names should have the correct capitalization |
| 157 | +MD044: |
| 158 | + # List of proper names |
| 159 | + names: [] |
| 160 | + # Include code blocks |
| 161 | + code_blocks: true |
| 162 | + # Include HTML elements |
| 163 | + html_elements: true |
| 164 | + |
| 165 | +# MD045/no-alt-text - Images should have alternate text (alt text) |
| 166 | +MD045: true |
| 167 | + |
| 168 | +# MD046/code-block-style - Code block style |
| 169 | +MD046: |
| 170 | + # Block style |
| 171 | + style: "consistent" |
| 172 | + |
| 173 | +# MD047/single-trailing-newline - Files should end with a single newline character |
| 174 | +MD047: true |
| 175 | + |
| 176 | +# MD048/code-fence-style - Code fence style |
| 177 | +MD048: |
| 178 | + # Code fence style |
| 179 | + style: "consistent" |
| 180 | + |
| 181 | +# MD049/emphasis-style - Emphasis style should be consistent |
| 182 | +MD049: |
| 183 | + # Emphasis style should be consistent |
| 184 | + style: "consistent" |
| 185 | + |
| 186 | +# MD050/strong-style - Strong style should be consistent |
| 187 | +MD050: |
| 188 | + # Strong style should be consistent |
| 189 | + style: "consistent" |
| 190 | + |
| 191 | +# MD051/link-fragments - Link fragments should be valid |
| 192 | +MD051: false |
| 193 | + |
| 194 | +# MD052/reference-links-images - Reference links and images should use a label that is defined |
| 195 | +MD052: true |
| 196 | + |
| 197 | +# MD053/link-image-reference-definitions - Link and image reference definitions should be needed |
| 198 | +MD053: true |
0 commit comments