|
| 1 | +default: false # includes/excludes all rules by default |
| 2 | + |
| 3 | +# Heading levels should only increment by one level at a time <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md001> |
| 4 | +MD001: true |
| 5 | + |
| 6 | +# Heading style <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md003> |
| 7 | +MD003: true |
| 8 | + |
| 9 | +# Unordered list style <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md004> |
| 10 | +MD004: true |
| 11 | + |
| 12 | +# Inconsistent indentation for list items at the same level <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md005> |
| 13 | +MD005: true |
| 14 | + |
| 15 | +# Consider starting bulleted lists at the beginning of the line <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md006> |
| 16 | +MD006: true |
| 17 | + |
| 18 | +# Unordered list indentation <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md007> |
| 19 | +MD007: true |
| 20 | + |
| 21 | +# Trailing spaces <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md009> |
| 22 | +MD009: true |
| 23 | + |
| 24 | +# Hard tabs <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md010> |
| 25 | +MD010: true |
| 26 | + |
| 27 | +# Reversed link syntax <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md011> |
| 28 | +MD011: true |
| 29 | + |
| 30 | +# Multiple consecutive blank lines <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md012> |
| 31 | +MD012: true |
| 32 | + |
| 33 | +# Line length <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md013> |
| 34 | +MD013: false |
| 35 | + |
| 36 | +# Dollar signs used before commands without showing output <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md014> |
| 37 | +MD014: false |
| 38 | + |
| 39 | +# No space after hash on atx style heading <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md018> |
| 40 | +MD018: true |
| 41 | + |
| 42 | +# Multiple spaces after hash on atx style heading <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md019> |
| 43 | +MD019: true |
| 44 | + |
| 45 | +# No space inside hashes on closed atx style heading <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md020> |
| 46 | +MD020: true |
| 47 | + |
| 48 | +# Multiple spaces inside hashes on closed atx style heading <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md021> |
| 49 | +MD021: true |
| 50 | + |
| 51 | +# Headings should be surrounded by blank lines <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md022> |
| 52 | +MD022: true |
| 53 | + |
| 54 | +# Headings must start at the beginning of the line <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md023> |
| 55 | +MD023: true |
| 56 | + |
| 57 | +# Multiple headings with the same content <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md024> |
| 58 | +MD024: |
| 59 | + allow_different_nesting: true |
| 60 | + |
| 61 | +# Multiple top level headings in the same document <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md025> |
| 62 | +MD025: true |
| 63 | + |
| 64 | +# Trailing punctuation in heading <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md026> |
| 65 | +MD026: true |
| 66 | + |
| 67 | +# Multiple spaces after blockquote symbol <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md027> |
| 68 | +MD027: true |
| 69 | + |
| 70 | +# Blank line inside blockquote <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md028> |
| 71 | +MD028: false |
| 72 | + |
| 73 | +# Ordered list item prefix <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md029> |
| 74 | +MD029: false |
| 75 | + |
| 76 | +# Spaces after list markers <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md030> |
| 77 | +MD030: true |
| 78 | + |
| 79 | +# Fenced code blocks should be surrounded by blank lines <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md031> |
| 80 | +MD031: true |
| 81 | + |
| 82 | +# Lists should be surrounded by blank lines <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md032> |
| 83 | +MD032: true |
| 84 | + |
| 85 | +# Inline HTML <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md033> |
| 86 | +MD033: true |
| 87 | + |
| 88 | +# Bare URL used <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md034> |
| 89 | +MD034: true |
| 90 | + |
| 91 | +# Horizontal rule style <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md035> |
| 92 | +MD035: |
| 93 | + style: '---' |
| 94 | + |
| 95 | +# Emphasis used instead of a heading <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md036> |
| 96 | +MD036: true |
| 97 | + |
| 98 | +# Spaces inside emphasis markers <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md037> |
| 99 | +MD037: true |
| 100 | + |
| 101 | +# Spaces inside code span elements <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md038> |
| 102 | +MD038: true |
| 103 | + |
| 104 | +# Spaces inside link text <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md039> |
| 105 | +MD039: true |
| 106 | + |
| 107 | +# Fenced code blocks should have a language specified <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md040> |
| 108 | +MD040: true |
| 109 | + |
| 110 | +# First line in file should be a top level heading <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md041> |
| 111 | +MD041: true |
| 112 | + |
| 113 | +# No empty links <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md042> |
| 114 | +MD042: true |
| 115 | + |
| 116 | +# Required heading structure <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md043> |
| 117 | +MD043: false |
| 118 | + |
| 119 | +# Proper names should have the correct capitalization <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md044> |
| 120 | +MD044: false |
| 121 | + |
| 122 | +# Images should have alternate text (alt text) <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md045> |
| 123 | +MD045: false |
| 124 | + |
| 125 | +# Code block style <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md046> |
| 126 | +MD046: |
| 127 | + style: 'fenced' |
| 128 | + |
| 129 | +# Files should end with a single newline character <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md047> |
| 130 | +MD047: true |
| 131 | + |
| 132 | +# Code fence style <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md048> |
| 133 | +MD048: |
| 134 | + style: 'backtick' |
| 135 | + |
| 136 | +# Custom rules: |
| 137 | +CHANGELOG-RULE-001: true |
| 138 | +CHANGELOG-RULE-002: true |
| 139 | +CHANGELOG-RULE-003: true |
| 140 | +CHANGELOG-RULE-004: true |
0 commit comments