2 "title": "Markdownlint configuration schema",
6 "description": "Default state for all rules",
11 "description": "Path to configuration file to extend",
19 "description": "JSON Schema URI (used by some editors)",
21 "default": "https://raw.githubusercontent.com/DavidAnson/markdownlint/main/schema/markdownlint-config-schema.json"
24 "description": "MD001/heading-increment/header-increment - Heading levels should only increment by one level at a time",
28 "heading-increment": {
29 "description": "MD001/heading-increment/header-increment - Heading levels should only increment by one level at a time",
34 "description": "MD001/heading-increment/header-increment - Heading levels should only increment by one level at a time",
39 "description": "MD002/first-heading-h1/first-header-h1 - First heading should be a top-level heading",
47 "description": "Heading level",
52 "additionalProperties": false
55 "description": "MD002/first-heading-h1/first-header-h1 - First heading should be a top-level heading",
63 "description": "Heading level",
68 "additionalProperties": false
71 "description": "MD002/first-heading-h1/first-header-h1 - First heading should be a top-level heading",
79 "description": "Heading level",
84 "additionalProperties": false
87 "description": "MD003/heading-style/header-style - Heading style",
95 "description": "Heading style",
103 "setext_with_atx_closed"
105 "default": "consistent"
108 "additionalProperties": false
111 "description": "MD003/heading-style/header-style - Heading style",
119 "description": "Heading style",
127 "setext_with_atx_closed"
129 "default": "consistent"
132 "additionalProperties": false
135 "description": "MD003/heading-style/header-style - Heading style",
143 "description": "Heading style",
151 "setext_with_atx_closed"
153 "default": "consistent"
156 "additionalProperties": false
159 "description": "MD004/ul-style - Unordered list style",
167 "description": "List style",
176 "default": "consistent"
179 "additionalProperties": false
182 "description": "MD004/ul-style - Unordered list style",
190 "description": "List style",
199 "default": "consistent"
202 "additionalProperties": false
205 "description": "MD005/list-indent - Inconsistent indentation for list items at the same level",
210 "description": "MD005/list-indent - Inconsistent indentation for list items at the same level",
215 "description": "MD006/ul-start-left - Consider starting bulleted lists at the beginning of the line",
220 "description": "MD006/ul-start-left - Consider starting bulleted lists at the beginning of the line",
225 "description": "MD007/ul-indent - Unordered list indentation",
233 "description": "Spaces for indent",
238 "description": "Whether to indent the first level of the list",
243 "additionalProperties": false
246 "description": "MD007/ul-indent - Unordered list indentation",
254 "description": "Spaces for indent",
259 "description": "Whether to indent the first level of the list",
264 "additionalProperties": false
267 "description": "MD009/no-trailing-spaces - Trailing spaces",
275 "description": "Spaces for line break",
279 "list_item_empty_lines": {
280 "description": "Allow spaces for empty lines in list items",
285 "description": "Include unnecessary breaks",
290 "additionalProperties": false
292 "no-trailing-spaces": {
293 "description": "MD009/no-trailing-spaces - Trailing spaces",
301 "description": "Spaces for line break",
305 "list_item_empty_lines": {
306 "description": "Allow spaces for empty lines in list items",
311 "description": "Include unnecessary breaks",
316 "additionalProperties": false
319 "description": "MD010/no-hard-tabs - Hard tabs",
327 "description": "Include code blocks",
332 "description": "Number of spaces for each hard tab",
337 "additionalProperties": false
340 "description": "MD010/no-hard-tabs - Hard tabs",
348 "description": "Include code blocks",
353 "description": "Number of spaces for each hard tab",
358 "additionalProperties": false
361 "description": "MD011/no-reversed-links - Reversed link syntax",
365 "no-reversed-links": {
366 "description": "MD011/no-reversed-links - Reversed link syntax",
371 "description": "MD012/no-multiple-blanks - Multiple consecutive blank lines",
379 "description": "Consecutive blank lines",
384 "additionalProperties": false
386 "no-multiple-blanks": {
387 "description": "MD012/no-multiple-blanks - Multiple consecutive blank lines",
395 "description": "Consecutive blank lines",
400 "additionalProperties": false
403 "description": "MD013/line-length - Line length",
411 "description": "Number of characters",
415 "heading_line_length": {
416 "description": "Number of characters for headings",
420 "code_block_line_length": {
421 "description": "Number of characters for code blocks",
426 "description": "Include code blocks",
431 "description": "Include tables",
436 "description": "Include headings",
441 "description": "Include headings",
446 "description": "Strict length checking",
451 "description": "Stern length checking",
456 "additionalProperties": false
459 "description": "MD013/line-length - Line length",
467 "description": "Number of characters",
471 "heading_line_length": {
472 "description": "Number of characters for headings",
476 "code_block_line_length": {
477 "description": "Number of characters for code blocks",
482 "description": "Include code blocks",
487 "description": "Include tables",
492 "description": "Include headings",
497 "description": "Include headings",
502 "description": "Strict length checking",
507 "description": "Stern length checking",
512 "additionalProperties": false
515 "description": "MD014/commands-show-output - Dollar signs used before commands without showing output",
519 "commands-show-output": {
520 "description": "MD014/commands-show-output - Dollar signs used before commands without showing output",
525 "description": "MD018/no-missing-space-atx - No space after hash on atx style heading",
529 "no-missing-space-atx": {
530 "description": "MD018/no-missing-space-atx - No space after hash on atx style heading",
535 "description": "MD019/no-multiple-space-atx - Multiple spaces after hash on atx style heading",
539 "no-multiple-space-atx": {
540 "description": "MD019/no-multiple-space-atx - Multiple spaces after hash on atx style heading",
545 "description": "MD020/no-missing-space-closed-atx - No space inside hashes on closed atx style heading",
549 "no-missing-space-closed-atx": {
550 "description": "MD020/no-missing-space-closed-atx - No space inside hashes on closed atx style heading",
555 "description": "MD021/no-multiple-space-closed-atx - Multiple spaces inside hashes on closed atx style heading",
559 "no-multiple-space-closed-atx": {
560 "description": "MD021/no-multiple-space-closed-atx - Multiple spaces inside hashes on closed atx style heading",
565 "description": "MD022/blanks-around-headings/blanks-around-headers - Headings should be surrounded by blank lines",
573 "description": "Blank lines above heading",
578 "description": "Blank lines below heading",
583 "additionalProperties": false
585 "blanks-around-headings": {
586 "description": "MD022/blanks-around-headings/blanks-around-headers - Headings should be surrounded by blank lines",
594 "description": "Blank lines above heading",
599 "description": "Blank lines below heading",
604 "additionalProperties": false
606 "blanks-around-headers": {
607 "description": "MD022/blanks-around-headings/blanks-around-headers - Headings should be surrounded by blank lines",
615 "description": "Blank lines above heading",
620 "description": "Blank lines below heading",
625 "additionalProperties": false
628 "description": "MD023/heading-start-left/header-start-left - Headings must start at the beginning of the line",
632 "heading-start-left": {
633 "description": "MD023/heading-start-left/header-start-left - Headings must start at the beginning of the line",
637 "header-start-left": {
638 "description": "MD023/heading-start-left/header-start-left - Headings must start at the beginning of the line",
643 "description": "MD024/no-duplicate-heading/no-duplicate-header - Multiple headings with the same content",
650 "allow_different_nesting": {
651 "description": "Only check sibling headings",
656 "description": "Only check sibling headings",
661 "additionalProperties": false
663 "no-duplicate-heading": {
664 "description": "MD024/no-duplicate-heading/no-duplicate-header - Multiple headings with the same content",
671 "allow_different_nesting": {
672 "description": "Only check sibling headings",
677 "description": "Only check sibling headings",
682 "additionalProperties": false
684 "no-duplicate-header": {
685 "description": "MD024/no-duplicate-heading/no-duplicate-header - Multiple headings with the same content",
692 "allow_different_nesting": {
693 "description": "Only check sibling headings",
698 "description": "Only check sibling headings",
703 "additionalProperties": false
706 "description": "MD025/single-title/single-h1 - Multiple top-level headings in the same document",
714 "description": "Heading level",
718 "front_matter_title": {
719 "description": "RegExp for matching title in front matter",
721 "default": "^\\s*title\\s*[:=]"
724 "additionalProperties": false
727 "description": "MD025/single-title/single-h1 - Multiple top-level headings in the same document",
735 "description": "Heading level",
739 "front_matter_title": {
740 "description": "RegExp for matching title in front matter",
742 "default": "^\\s*title\\s*[:=]"
745 "additionalProperties": false
748 "description": "MD025/single-title/single-h1 - Multiple top-level headings in the same document",
756 "description": "Heading level",
760 "front_matter_title": {
761 "description": "RegExp for matching title in front matter",
763 "default": "^\\s*title\\s*[:=]"
766 "additionalProperties": false
769 "description": "MD026/no-trailing-punctuation - Trailing punctuation in heading",
777 "description": "Punctuation characters",
779 "default": ".,;:!。,;:!"
782 "additionalProperties": false
784 "no-trailing-punctuation": {
785 "description": "MD026/no-trailing-punctuation - Trailing punctuation in heading",
793 "description": "Punctuation characters",
795 "default": ".,;:!。,;:!"
798 "additionalProperties": false
801 "description": "MD027/no-multiple-space-blockquote - Multiple spaces after blockquote symbol",
805 "no-multiple-space-blockquote": {
806 "description": "MD027/no-multiple-space-blockquote - Multiple spaces after blockquote symbol",
811 "description": "MD028/no-blanks-blockquote - Blank line inside blockquote",
815 "no-blanks-blockquote": {
816 "description": "MD028/no-blanks-blockquote - Blank line inside blockquote",
821 "description": "MD029/ol-prefix - Ordered list item prefix",
829 "description": "List style",
837 "default": "one_or_ordered"
840 "additionalProperties": false
843 "description": "MD029/ol-prefix - Ordered list item prefix",
851 "description": "List style",
859 "default": "one_or_ordered"
862 "additionalProperties": false
865 "description": "MD030/list-marker-space - Spaces after list markers",
873 "description": "Spaces for single-line unordered list items",
878 "description": "Spaces for single-line ordered list items",
883 "description": "Spaces for multi-line unordered list items",
888 "description": "Spaces for multi-line ordered list items",
893 "additionalProperties": false
895 "list-marker-space": {
896 "description": "MD030/list-marker-space - Spaces after list markers",
904 "description": "Spaces for single-line unordered list items",
909 "description": "Spaces for single-line ordered list items",
914 "description": "Spaces for multi-line unordered list items",
919 "description": "Spaces for multi-line ordered list items",
924 "additionalProperties": false
927 "description": "MD031/blanks-around-fences - Fenced code blocks should be surrounded by blank lines",
935 "description": "Include list items",
940 "additionalProperties": false
942 "blanks-around-fences": {
943 "description": "MD031/blanks-around-fences - Fenced code blocks should be surrounded by blank lines",
951 "description": "Include list items",
956 "additionalProperties": false
959 "description": "MD032/blanks-around-lists - Lists should be surrounded by blank lines",
963 "blanks-around-lists": {
964 "description": "MD032/blanks-around-lists - Lists should be surrounded by blank lines",
969 "description": "MD033/no-inline-html - Inline HTML",
976 "allowed_elements": {
977 "description": "Allowed elements",
985 "additionalProperties": false
988 "description": "MD033/no-inline-html - Inline HTML",
995 "allowed_elements": {
996 "description": "Allowed elements",
1004 "additionalProperties": false
1007 "description": "MD034/no-bare-urls - Bare URL used",
1012 "description": "MD034/no-bare-urls - Bare URL used",
1017 "description": "MD035/hr-style - Horizontal rule style",
1025 "description": "Horizontal rule style",
1027 "default": "consistent"
1030 "additionalProperties": false
1033 "description": "MD035/hr-style - Horizontal rule style",
1041 "description": "Horizontal rule style",
1043 "default": "consistent"
1046 "additionalProperties": false
1049 "description": "MD036/no-emphasis-as-heading/no-emphasis-as-header - Emphasis used instead of a heading",
1057 "description": "Punctuation characters",
1059 "default": ".,;:!?。,;:!?"
1062 "additionalProperties": false
1064 "no-emphasis-as-heading": {
1065 "description": "MD036/no-emphasis-as-heading/no-emphasis-as-header - Emphasis used instead of a heading",
1073 "description": "Punctuation characters",
1075 "default": ".,;:!?。,;:!?"
1078 "additionalProperties": false
1080 "no-emphasis-as-header": {
1081 "description": "MD036/no-emphasis-as-heading/no-emphasis-as-header - Emphasis used instead of a heading",
1089 "description": "Punctuation characters",
1091 "default": ".,;:!?。,;:!?"
1094 "additionalProperties": false
1097 "description": "MD037/no-space-in-emphasis - Spaces inside emphasis markers",
1101 "no-space-in-emphasis": {
1102 "description": "MD037/no-space-in-emphasis - Spaces inside emphasis markers",
1107 "description": "MD038/no-space-in-code - Spaces inside code span elements",
1111 "no-space-in-code": {
1112 "description": "MD038/no-space-in-code - Spaces inside code span elements",
1117 "description": "MD039/no-space-in-links - Spaces inside link text",
1121 "no-space-in-links": {
1122 "description": "MD039/no-space-in-links - Spaces inside link text",
1127 "description": "MD040/fenced-code-language - Fenced code blocks should have a language specified",
1131 "fenced-code-language": {
1132 "description": "MD040/fenced-code-language - Fenced code blocks should have a language specified",
1137 "description": "MD041/first-line-heading/first-line-h1 - First line in a file should be a top-level heading",
1145 "description": "Heading level",
1149 "front_matter_title": {
1150 "description": "RegExp for matching title in front matter",
1152 "default": "^\\s*title\\s*[:=]"
1155 "additionalProperties": false
1157 "first-line-heading": {
1158 "description": "MD041/first-line-heading/first-line-h1 - First line in a file should be a top-level heading",
1166 "description": "Heading level",
1170 "front_matter_title": {
1171 "description": "RegExp for matching title in front matter",
1173 "default": "^\\s*title\\s*[:=]"
1176 "additionalProperties": false
1179 "description": "MD041/first-line-heading/first-line-h1 - First line in a file should be a top-level heading",
1187 "description": "Heading level",
1191 "front_matter_title": {
1192 "description": "RegExp for matching title in front matter",
1194 "default": "^\\s*title\\s*[:=]"
1197 "additionalProperties": false
1200 "description": "MD042/no-empty-links - No empty links",
1205 "description": "MD042/no-empty-links - No empty links",
1210 "description": "MD043/required-headings/required-headers - Required heading structure",
1218 "description": "List of headings",
1226 "description": "List of headings",
1234 "additionalProperties": false
1236 "required-headings": {
1237 "description": "MD043/required-headings/required-headers - Required heading structure",
1245 "description": "List of headings",
1253 "description": "List of headings",
1261 "additionalProperties": false
1263 "required-headers": {
1264 "description": "MD043/required-headings/required-headers - Required heading structure",
1272 "description": "List of headings",
1280 "description": "List of headings",
1288 "additionalProperties": false
1291 "description": "MD044/proper-names - Proper names should have the correct capitalization",
1299 "description": "List of proper names",
1307 "description": "Include code blocks",
1312 "additionalProperties": false
1315 "description": "MD044/proper-names - Proper names should have the correct capitalization",
1323 "description": "List of proper names",
1331 "description": "Include code blocks",
1336 "additionalProperties": false
1339 "description": "MD045/no-alt-text - Images should have alternate text (alt text)",
1344 "description": "MD045/no-alt-text - Images should have alternate text (alt text)",
1349 "description": "MD046/code-block-style - Code block style",
1357 "description": "Block style",
1364 "default": "consistent"
1367 "additionalProperties": false
1369 "code-block-style": {
1370 "description": "MD046/code-block-style - Code block style",
1378 "description": "Block style",
1385 "default": "consistent"
1388 "additionalProperties": false
1391 "description": "MD047/single-trailing-newline - Files should end with a single newline character",
1395 "single-trailing-newline": {
1396 "description": "MD047/single-trailing-newline - Files should end with a single newline character",
1401 "description": "MD048/code-fence-style - Code fence style",
1409 "description": "Code fence style",
1416 "default": "consistent"
1419 "additionalProperties": false
1421 "code-fence-style": {
1422 "description": "MD048/code-fence-style - Code fence style",
1430 "description": "Code fence style",
1437 "default": "consistent"
1440 "additionalProperties": false
1443 "description": "headings - MD001, MD002, MD003, MD018, MD019, MD020, MD021, MD022, MD023, MD024, MD025, MD026, MD036, MD041, MD043",
1448 "description": "headers - MD001, MD002, MD003, MD018, MD019, MD020, MD021, MD022, MD023, MD024, MD025, MD026, MD036, MD041, MD043",
1453 "description": "bullet - MD004, MD005, MD006, MD007, MD032",
1458 "description": "ul - MD004, MD005, MD006, MD007, MD030, MD032",
1463 "description": "indentation - MD005, MD006, MD007, MD027",
1468 "description": "whitespace - MD009, MD010, MD012, MD027, MD028, MD030, MD037, MD038, MD039",
1473 "description": "hard_tab - MD010",
1478 "description": "links - MD011, MD034, MD039, MD042",
1483 "description": "blank_lines - MD012, MD022, MD031, MD032, MD047",
1488 "description": "line_length - MD013",
1493 "description": "code - MD014, MD031, MD038, MD040, MD046, MD048",
1498 "description": "atx - MD018, MD019",
1503 "description": "spaces - MD018, MD019, MD020, MD021, MD023",
1508 "description": "atx_closed - MD020, MD021",
1513 "description": "blockquote - MD027, MD028",
1518 "description": "ol - MD029, MD030, MD032",
1523 "description": "html - MD033",
1528 "description": "url - MD034",
1533 "description": "hr - MD035",
1538 "description": "emphasis - MD036, MD037",
1543 "description": "language - MD040",
1548 "description": "spelling - MD044",
1553 "description": "accessibility - MD045",
1558 "description": "images - MD045",
1563 "additionalProperties": {