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