2 "title": "Markdownlint configuration schema",
6 "description": "Default state for all rules",
11 "description": "Path to configuration file to extend",
16 "description": "JSON Schema URI (used by some editors)",
18 "default": "https://raw.githubusercontent.com/DavidAnson/markdownlint/main/schema/markdownlint-config-schema.json"
21 "description": "MD001/heading-increment/header-increment - Heading levels should only increment by one level at a time",
25 "heading-increment": {
26 "description": "MD001/heading-increment/header-increment - Heading levels should only increment by one level at a time",
31 "description": "MD001/heading-increment/header-increment - Heading levels should only increment by one level at a time",
36 "description": "MD002/first-heading-h1/first-header-h1 - First heading should be a top level heading",
44 "description": "Heading level",
49 "additionalProperties": false
52 "description": "MD002/first-heading-h1/first-header-h1 - First heading should be a top level heading",
60 "description": "Heading level",
65 "additionalProperties": false
68 "description": "MD002/first-heading-h1/first-header-h1 - First heading should be a top level heading",
76 "description": "Heading level",
81 "additionalProperties": false
84 "description": "MD003/heading-style/header-style - Heading style",
92 "description": "Heading style",
100 "setext_with_atx_closed"
102 "default": "consistent"
105 "additionalProperties": false
108 "description": "MD003/heading-style/header-style - Heading style",
116 "description": "Heading style",
124 "setext_with_atx_closed"
126 "default": "consistent"
129 "additionalProperties": false
132 "description": "MD003/heading-style/header-style - Heading style",
140 "description": "Heading style",
148 "setext_with_atx_closed"
150 "default": "consistent"
153 "additionalProperties": false
156 "description": "MD004/ul-style - Unordered list style",
164 "description": "List style",
173 "default": "consistent"
176 "additionalProperties": false
179 "description": "MD004/ul-style - Unordered list style",
187 "description": "List style",
196 "default": "consistent"
199 "additionalProperties": false
202 "description": "MD005/list-indent - Inconsistent indentation for list items at the same level",
207 "description": "MD005/list-indent - Inconsistent indentation for list items at the same level",
212 "description": "MD006/ul-start-left - Consider starting bulleted lists at the beginning of the line",
217 "description": "MD006/ul-start-left - Consider starting bulleted lists at the beginning of the line",
222 "description": "MD007/ul-indent - Unordered list indentation",
230 "description": "Spaces for indent",
235 "description": "Whether to indent the first level of the list",
240 "additionalProperties": false
243 "description": "MD007/ul-indent - Unordered list indentation",
251 "description": "Spaces for indent",
256 "description": "Whether to indent the first level of the list",
261 "additionalProperties": false
264 "description": "MD009/no-trailing-spaces - Trailing spaces",
272 "description": "Spaces for line break",
276 "list_item_empty_lines": {
277 "description": "Allow spaces for empty lines in list items",
282 "description": "Include unnecessary breaks",
287 "additionalProperties": false
289 "no-trailing-spaces": {
290 "description": "MD009/no-trailing-spaces - Trailing spaces",
298 "description": "Spaces for line break",
302 "list_item_empty_lines": {
303 "description": "Allow spaces for empty lines in list items",
308 "description": "Include unnecessary breaks",
313 "additionalProperties": false
316 "description": "MD010/no-hard-tabs - Hard tabs",
324 "description": "Include code blocks",
329 "additionalProperties": false
332 "description": "MD010/no-hard-tabs - Hard tabs",
340 "description": "Include code blocks",
345 "additionalProperties": false
348 "description": "MD011/no-reversed-links - Reversed link syntax",
352 "no-reversed-links": {
353 "description": "MD011/no-reversed-links - Reversed link syntax",
358 "description": "MD012/no-multiple-blanks - Multiple consecutive blank lines",
366 "description": "Consecutive blank lines",
371 "additionalProperties": false
373 "no-multiple-blanks": {
374 "description": "MD012/no-multiple-blanks - Multiple consecutive blank lines",
382 "description": "Consecutive blank lines",
387 "additionalProperties": false
390 "description": "MD013/line-length - Line length",
398 "description": "Number of characters",
402 "heading_line_length": {
403 "description": "Number of characters for headings",
407 "code_block_line_length": {
408 "description": "Number of characters for code blocks",
413 "description": "Include code blocks",
418 "description": "Include tables",
423 "description": "Include headings",
428 "description": "Include headings",
433 "description": "Strict length checking",
438 "description": "Stern length checking",
443 "additionalProperties": false
446 "description": "MD013/line-length - Line length",
454 "description": "Number of characters",
458 "heading_line_length": {
459 "description": "Number of characters for headings",
463 "code_block_line_length": {
464 "description": "Number of characters for code blocks",
469 "description": "Include code blocks",
474 "description": "Include tables",
479 "description": "Include headings",
484 "description": "Include headings",
489 "description": "Strict length checking",
494 "description": "Stern length checking",
499 "additionalProperties": false
502 "description": "MD014/commands-show-output - Dollar signs used before commands without showing output",
506 "commands-show-output": {
507 "description": "MD014/commands-show-output - Dollar signs used before commands without showing output",
512 "description": "MD018/no-missing-space-atx - No space after hash on atx style heading",
516 "no-missing-space-atx": {
517 "description": "MD018/no-missing-space-atx - No space after hash on atx style heading",
522 "description": "MD019/no-multiple-space-atx - Multiple spaces after hash on atx style heading",
526 "no-multiple-space-atx": {
527 "description": "MD019/no-multiple-space-atx - Multiple spaces after hash on atx style heading",
532 "description": "MD020/no-missing-space-closed-atx - No space inside hashes on closed atx style heading",
536 "no-missing-space-closed-atx": {
537 "description": "MD020/no-missing-space-closed-atx - No space inside hashes on closed atx style heading",
542 "description": "MD021/no-multiple-space-closed-atx - Multiple spaces inside hashes on closed atx style heading",
546 "no-multiple-space-closed-atx": {
547 "description": "MD021/no-multiple-space-closed-atx - Multiple spaces inside hashes on closed atx style heading",
552 "description": "MD022/blanks-around-headings/blanks-around-headers - Headings should be surrounded by blank lines",
560 "description": "Blank lines above heading",
565 "description": "Blank lines below heading",
570 "additionalProperties": false
572 "blanks-around-headings": {
573 "description": "MD022/blanks-around-headings/blanks-around-headers - Headings should be surrounded by blank lines",
581 "description": "Blank lines above heading",
586 "description": "Blank lines below heading",
591 "additionalProperties": false
593 "blanks-around-headers": {
594 "description": "MD022/blanks-around-headings/blanks-around-headers - Headings should be surrounded by blank lines",
602 "description": "Blank lines above heading",
607 "description": "Blank lines below heading",
612 "additionalProperties": false
615 "description": "MD023/heading-start-left/header-start-left - Headings must start at the beginning of the line",
619 "heading-start-left": {
620 "description": "MD023/heading-start-left/header-start-left - Headings must start at the beginning of the line",
624 "header-start-left": {
625 "description": "MD023/heading-start-left/header-start-left - Headings must start at the beginning of the line",
630 "description": "MD024/no-duplicate-heading/no-duplicate-header - Multiple headings with the same content",
637 "allow_different_nesting": {
638 "description": "Only check sibling headings",
643 "description": "Only check sibling headings",
648 "additionalProperties": false
650 "no-duplicate-heading": {
651 "description": "MD024/no-duplicate-heading/no-duplicate-header - Multiple headings with the same content",
658 "allow_different_nesting": {
659 "description": "Only check sibling headings",
664 "description": "Only check sibling headings",
669 "additionalProperties": false
671 "no-duplicate-header": {
672 "description": "MD024/no-duplicate-heading/no-duplicate-header - Multiple headings with the same content",
679 "allow_different_nesting": {
680 "description": "Only check sibling headings",
685 "description": "Only check sibling headings",
690 "additionalProperties": false
693 "description": "MD025/single-title/single-h1 - Multiple top level headings in the same document",
701 "description": "Heading level",
705 "front_matter_title": {
706 "description": "RegExp for matching title in front matter",
708 "default": "^\\s*title\\s*[:=]"
711 "additionalProperties": false
714 "description": "MD025/single-title/single-h1 - Multiple top level headings in the same document",
722 "description": "Heading level",
726 "front_matter_title": {
727 "description": "RegExp for matching title in front matter",
729 "default": "^\\s*title\\s*[:=]"
732 "additionalProperties": false
735 "description": "MD025/single-title/single-h1 - Multiple top level headings in the same document",
743 "description": "Heading level",
747 "front_matter_title": {
748 "description": "RegExp for matching title in front matter",
750 "default": "^\\s*title\\s*[:=]"
753 "additionalProperties": false
756 "description": "MD026/no-trailing-punctuation - Trailing punctuation in heading",
764 "description": "Punctuation characters",
766 "default": ".,;:!。,;:!"
769 "additionalProperties": false
771 "no-trailing-punctuation": {
772 "description": "MD026/no-trailing-punctuation - Trailing punctuation in heading",
780 "description": "Punctuation characters",
782 "default": ".,;:!。,;:!"
785 "additionalProperties": false
788 "description": "MD027/no-multiple-space-blockquote - Multiple spaces after blockquote symbol",
792 "no-multiple-space-blockquote": {
793 "description": "MD027/no-multiple-space-blockquote - Multiple spaces after blockquote symbol",
798 "description": "MD028/no-blanks-blockquote - Blank line inside blockquote",
802 "no-blanks-blockquote": {
803 "description": "MD028/no-blanks-blockquote - Blank line inside blockquote",
808 "description": "MD029/ol-prefix - Ordered list item prefix",
816 "description": "List style",
824 "default": "one_or_ordered"
827 "additionalProperties": false
830 "description": "MD029/ol-prefix - Ordered list item prefix",
838 "description": "List style",
846 "default": "one_or_ordered"
849 "additionalProperties": false
852 "description": "MD030/list-marker-space - Spaces after list markers",
860 "description": "Spaces for single-line unordered list items",
865 "description": "Spaces for single-line ordered list items",
870 "description": "Spaces for multi-line unordered list items",
875 "description": "Spaces for multi-line ordered list items",
880 "additionalProperties": false
882 "list-marker-space": {
883 "description": "MD030/list-marker-space - Spaces after list markers",
891 "description": "Spaces for single-line unordered list items",
896 "description": "Spaces for single-line ordered list items",
901 "description": "Spaces for multi-line unordered list items",
906 "description": "Spaces for multi-line ordered list items",
911 "additionalProperties": false
914 "description": "MD031/blanks-around-fences - Fenced code blocks should be surrounded by blank lines",
922 "description": "Include list items",
927 "additionalProperties": false
929 "blanks-around-fences": {
930 "description": "MD031/blanks-around-fences - Fenced code blocks should be surrounded by blank lines",
938 "description": "Include list items",
943 "additionalProperties": false
946 "description": "MD032/blanks-around-lists - Lists should be surrounded by blank lines",
950 "blanks-around-lists": {
951 "description": "MD032/blanks-around-lists - Lists should be surrounded by blank lines",
956 "description": "MD033/no-inline-html - Inline HTML",
963 "allowed_elements": {
964 "description": "Allowed elements",
972 "additionalProperties": false
975 "description": "MD033/no-inline-html - Inline HTML",
982 "allowed_elements": {
983 "description": "Allowed elements",
991 "additionalProperties": false
994 "description": "MD034/no-bare-urls - Bare URL used",
999 "description": "MD034/no-bare-urls - Bare URL used",
1004 "description": "MD035/hr-style - Horizontal rule style",
1012 "description": "Horizontal rule style",
1014 "default": "consistent"
1017 "additionalProperties": false
1020 "description": "MD035/hr-style - Horizontal rule style",
1028 "description": "Horizontal rule style",
1030 "default": "consistent"
1033 "additionalProperties": false
1036 "description": "MD036/no-emphasis-as-heading/no-emphasis-as-header - Emphasis used instead of a heading",
1044 "description": "Punctuation characters",
1046 "default": ".,;:!?。,;:!?"
1049 "additionalProperties": false
1051 "no-emphasis-as-heading": {
1052 "description": "MD036/no-emphasis-as-heading/no-emphasis-as-header - Emphasis used instead of a heading",
1060 "description": "Punctuation characters",
1062 "default": ".,;:!?。,;:!?"
1065 "additionalProperties": false
1067 "no-emphasis-as-header": {
1068 "description": "MD036/no-emphasis-as-heading/no-emphasis-as-header - Emphasis used instead of a heading",
1076 "description": "Punctuation characters",
1078 "default": ".,;:!?。,;:!?"
1081 "additionalProperties": false
1084 "description": "MD037/no-space-in-emphasis - Spaces inside emphasis markers",
1088 "no-space-in-emphasis": {
1089 "description": "MD037/no-space-in-emphasis - Spaces inside emphasis markers",
1094 "description": "MD038/no-space-in-code - Spaces inside code span elements",
1098 "no-space-in-code": {
1099 "description": "MD038/no-space-in-code - Spaces inside code span elements",
1104 "description": "MD039/no-space-in-links - Spaces inside link text",
1108 "no-space-in-links": {
1109 "description": "MD039/no-space-in-links - Spaces inside link text",
1114 "description": "MD040/fenced-code-language - Fenced code blocks should have a language specified",
1118 "fenced-code-language": {
1119 "description": "MD040/fenced-code-language - Fenced code blocks should have a language specified",
1124 "description": "MD041/first-line-heading/first-line-h1 - First line in file should be a top level heading",
1132 "description": "Heading level",
1136 "front_matter_title": {
1137 "description": "RegExp for matching title in front matter",
1139 "default": "^\\s*title\\s*[:=]"
1142 "additionalProperties": false
1144 "first-line-heading": {
1145 "description": "MD041/first-line-heading/first-line-h1 - First line in file should be a top level heading",
1153 "description": "Heading level",
1157 "front_matter_title": {
1158 "description": "RegExp for matching title in front matter",
1160 "default": "^\\s*title\\s*[:=]"
1163 "additionalProperties": false
1166 "description": "MD041/first-line-heading/first-line-h1 - First line in file should be a top level heading",
1174 "description": "Heading level",
1178 "front_matter_title": {
1179 "description": "RegExp for matching title in front matter",
1181 "default": "^\\s*title\\s*[:=]"
1184 "additionalProperties": false
1187 "description": "MD042/no-empty-links - No empty links",
1192 "description": "MD042/no-empty-links - No empty links",
1197 "description": "MD043/required-headings/required-headers - Required heading structure",
1205 "description": "List of headings",
1213 "description": "List of headings",
1221 "additionalProperties": false
1223 "required-headings": {
1224 "description": "MD043/required-headings/required-headers - Required heading structure",
1232 "description": "List of headings",
1240 "description": "List of headings",
1248 "additionalProperties": false
1250 "required-headers": {
1251 "description": "MD043/required-headings/required-headers - Required heading structure",
1259 "description": "List of headings",
1267 "description": "List of headings",
1275 "additionalProperties": false
1278 "description": "MD044/proper-names - Proper names should have the correct capitalization",
1286 "description": "List of proper names",
1294 "description": "Include code blocks",
1299 "additionalProperties": false
1302 "description": "MD044/proper-names - Proper names should have the correct capitalization",
1310 "description": "List of proper names",
1318 "description": "Include code blocks",
1323 "additionalProperties": false
1326 "description": "MD045/no-alt-text - Images should have alternate text (alt text)",
1331 "description": "MD045/no-alt-text - Images should have alternate text (alt text)",
1336 "description": "MD046/code-block-style - Code block style",
1344 "description": "Block style",
1351 "default": "consistent"
1354 "additionalProperties": false
1356 "code-block-style": {
1357 "description": "MD046/code-block-style - Code block style",
1365 "description": "Block style",
1372 "default": "consistent"
1375 "additionalProperties": false
1378 "description": "MD047/single-trailing-newline - Files should end with a single newline character",
1382 "single-trailing-newline": {
1383 "description": "MD047/single-trailing-newline - Files should end with a single newline character",
1388 "description": "MD048/code-fence-style - Code fence style",
1396 "description": "Code fence syle",
1403 "default": "consistent"
1406 "additionalProperties": false
1408 "code-fence-style": {
1409 "description": "MD048/code-fence-style - Code fence style",
1417 "description": "Code fence syle",
1424 "default": "consistent"
1427 "additionalProperties": false
1430 "description": "headings - MD001, MD002, MD003, MD018, MD019, MD020, MD021, MD022, MD023, MD024, MD025, MD026, MD036, MD041, MD043",
1435 "description": "headers - MD001, MD002, MD003, MD018, MD019, MD020, MD021, MD022, MD023, MD024, MD025, MD026, MD036, MD041, MD043",
1440 "description": "bullet - MD004, MD005, MD006, MD007, MD032",
1445 "description": "ul - MD004, MD005, MD006, MD007, MD030, MD032",
1450 "description": "indentation - MD005, MD006, MD007, MD027",
1455 "description": "whitespace - MD009, MD010, MD012, MD027, MD028, MD030, MD037, MD038, MD039",
1460 "description": "hard_tab - MD010",
1465 "description": "links - MD011, MD034, MD039, MD042",
1470 "description": "blank_lines - MD012, MD022, MD031, MD032, MD047",
1475 "description": "line_length - MD013",
1480 "description": "code - MD014, MD031, MD038, MD040, MD046, MD048",
1485 "description": "atx - MD018, MD019",
1490 "description": "spaces - MD018, MD019, MD020, MD021, MD023",
1495 "description": "atx_closed - MD020, MD021",
1500 "description": "blockquote - MD027, MD028",
1505 "description": "ol - MD029, MD030, MD032",
1510 "description": "html - MD033",
1515 "description": "url - MD034",
1520 "description": "hr - MD035",
1525 "description": "emphasis - MD036, MD037",
1530 "description": "language - MD040",
1535 "description": "spelling - MD044",
1540 "description": "accessibility - MD045",
1545 "description": "images - MD045",
1550 "additionalProperties": {