.markdownlint.yml 9.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253
  1. # Example markdownlint configuration with all properties set to their default value
  2. # Default state for all rules
  3. default: true
  4. # Path to configuration file to extend
  5. extends: null
  6. # MD001/heading-increment : Heading levels should only increment by one level at a time : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md001.md
  7. # NOTE: The docs intentionally jump heading levels for anchor stability, so skip this rule globally.
  8. MD001: false
  9. # MD003/heading-style : Heading style : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md003.md
  10. MD003:
  11. # Heading style
  12. style: "consistent"
  13. # MD004/ul-style : Unordered list style : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md004.md
  14. MD004:
  15. # List style
  16. style: "consistent"
  17. # MD005/list-indent : Inconsistent indentation for list items at the same level : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md005.md
  18. MD005: true
  19. # MD007/ul-indent : Unordered list indentation : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md007.md
  20. MD007:
  21. # Spaces for indent
  22. indent:
  23. # Whether to indent the first level of the list
  24. start_indented: false
  25. # Spaces for first level indent (when start_indented is set)
  26. start_indent: 2
  27. # MD009/no-trailing-spaces : Trailing spaces : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md009.md
  28. MD009:
  29. # Spaces for line break
  30. br_spaces: 2
  31. # Allow spaces for empty lines in list items
  32. list_item_empty_lines: false
  33. # Include unnecessary breaks
  34. strict: true
  35. # MD010/no-hard-tabs : Hard tabs : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md010.md
  36. MD010:
  37. # Include code blocks
  38. code_blocks: true
  39. # Fenced code languages to ignore
  40. ignore_code_languages: []
  41. # Number of spaces for each hard tab
  42. spaces_per_tab: 4
  43. # MD011/no-reversed-links : Reversed link syntax : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md011.md
  44. MD011: true
  45. # MD012/no-multiple-blanks : Multiple consecutive blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md012.md
  46. MD012:
  47. # Consecutive blank lines
  48. maximum: 1
  49. # MD013/line-length : Line length : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md013.md
  50. MD013: false
  51. # MD014/commands-show-output : Dollar signs used before commands without showing output : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md014.md
  52. MD014: true
  53. # MD018/no-missing-space-atx : No space after hash on atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md018.md
  54. MD018: true
  55. # MD019/no-multiple-space-atx : Multiple spaces after hash on atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md019.md
  56. MD019: true
  57. # MD020/no-missing-space-closed-atx : No space inside hashes on closed atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md020.md
  58. MD020: true
  59. # MD021/no-multiple-space-closed-atx : Multiple spaces inside hashes on closed atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md021.md
  60. MD021: true
  61. # MD022/blanks-around-headings : Headings should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md022.md
  62. MD022:
  63. # Blank lines above heading
  64. lines_above: 1
  65. # Blank lines below heading
  66. lines_below: 1
  67. # MD023/heading-start-left : Headings must start at the beginning of the line : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md023.md
  68. MD023: true
  69. # MD024/no-duplicate-heading : Multiple headings with the same content : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md024.md
  70. MD024: false
  71. # MD025/single-title/single-h1 : Multiple top-level headings in the same document : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md025.md
  72. MD025:
  73. # Heading level
  74. level: 1
  75. # RegExp for matching title in front matter
  76. front_matter_title: "^\\s*title\\s*[:=]"
  77. # MD026/no-trailing-punctuation : Trailing punctuation in heading : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md026.md
  78. MD026:
  79. # Punctuation characters
  80. punctuation: ".,;:!。,;:!"
  81. # MD027/no-multiple-space-blockquote : Multiple spaces after blockquote symbol : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md027.md
  82. MD027: true
  83. # MD028/no-blanks-blockquote : Blank line inside blockquote : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md028.md
  84. MD028: true
  85. # MD029/ol-prefix : Ordered list item prefix : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md029.md
  86. MD029:
  87. # List style
  88. style: "one_or_ordered"
  89. # MD030/list-marker-space : Spaces after list markers : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md030.md
  90. MD030:
  91. # Spaces for single-line unordered list items
  92. ul_single: 1
  93. # Spaces for single-line ordered list items
  94. ol_single: 1
  95. # Spaces for multi-line unordered list items
  96. ul_multi: 1
  97. # Spaces for multi-line ordered list items
  98. ol_multi: 1
  99. # MD031/blanks-around-fences : Fenced code blocks should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md031.md
  100. MD031:
  101. # Include list items
  102. list_items: true
  103. # MD032/blanks-around-lists : Lists should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md032.md
  104. MD032: true
  105. # MD033/no-inline-html : Inline HTML : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md033.md
  106. MD033: false
  107. # MD034/no-bare-urls : Bare URL used : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md034.md
  108. MD034: true
  109. # MD035/hr-style : Horizontal rule style : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md035.md
  110. MD035:
  111. # Horizontal rule style
  112. style: "consistent"
  113. # MD036/no-emphasis-as-heading : Emphasis used instead of a heading : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md036.md
  114. MD036:
  115. # Punctuation characters
  116. punctuation: ".,;:!?。,;:!?"
  117. # MD037/no-space-in-emphasis : Spaces inside emphasis markers : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md037.md
  118. MD037: true
  119. # MD038/no-space-in-code : Spaces inside code span elements : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md038.md
  120. MD038: true
  121. # MD039/no-space-in-links : Spaces inside link text : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md039.md
  122. MD039: true
  123. # MD040/fenced-code-language : Fenced code blocks should have a language specified : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md040.md
  124. MD040:
  125. # List of languages
  126. allowed_languages: []
  127. # Require language only
  128. language_only: false
  129. # 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.34.0/doc/md041.md
  130. MD041:
  131. # Heading level
  132. level: 1
  133. # RegExp for matching title in front matter
  134. front_matter_title: "^\\s*title\\s*[:=]"
  135. # MD042/no-empty-links : No empty links : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md042.md
  136. MD042: true
  137. # MD043/required-headings : Required heading structure : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md043.md
  138. MD043: false
  139. # MD044/proper-names : Proper names should have the correct capitalization : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md044.md
  140. MD044:
  141. # List of proper names
  142. names: []
  143. # Include code blocks
  144. code_blocks: true
  145. # Include HTML elements
  146. html_elements: true
  147. # MD045/no-alt-text : Images should have alternate text (alt text) : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md045.md
  148. MD045: false
  149. # MD046/code-block-style : Code block style : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md046.md
  150. MD046:
  151. # Block style
  152. style: "fenced"
  153. # MD047/single-trailing-newline : Files should end with a single newline character : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md047.md
  154. MD047: true
  155. # MD048/code-fence-style : Code fence style : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md048.md
  156. MD048:
  157. # Code fence style
  158. style: "backtick"
  159. # MD049/emphasis-style : Emphasis style : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md049.md
  160. MD049:
  161. # Emphasis style
  162. style: "consistent"
  163. # MD050/strong-style : Strong style : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md050.md
  164. MD050:
  165. # Strong style
  166. style: "consistent"
  167. # MD051/link-fragments : Link fragments should be valid : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md051.md
  168. MD051: true
  169. # MD052/reference-links-images : Reference links and images should use a label that is defined : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md052.md
  170. MD052:
  171. # Include shortcut syntax
  172. shortcut_syntax: false
  173. # MD053/link-image-reference-definitions : Link and image reference definitions should be needed : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md053.md
  174. MD053:
  175. # Ignored definitions
  176. ignored_definitions:
  177. - "//"
  178. # MD054/link-image-style : Link and image style : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md054.md
  179. MD054:
  180. # Allow autolinks
  181. autolink: false
  182. # Allow inline links and images
  183. inline: true
  184. # Allow full reference links and images
  185. full: true
  186. # Allow collapsed reference links and images
  187. collapsed: true
  188. # Allow shortcut reference links and images
  189. shortcut: true
  190. # Allow URLs as inline links
  191. url_inline: true
  192. # MD055/table-pipe-style : Table pipe style : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md055.md
  193. MD055:
  194. # Table pipe style
  195. style: "consistent"
  196. # MD060/table-column-style : Table column style : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md060.md
  197. # NOTE: Legacy docs rely on hand-crafted alignment, so disable this rule to avoid noisy warnings.
  198. MD060: false
  199. # MD056/table-column-count : Table column count : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md056.md
  200. MD056: true