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 "additionalProperties": false
335 "description": "MD010/no-hard-tabs - Hard tabs",
343 "description": "Include code blocks",
348 "additionalProperties": false
351 "description": "MD011/no-reversed-links - Reversed link syntax",
355 "no-reversed-links": {
356 "description": "MD011/no-reversed-links - Reversed link syntax",
361 "description": "MD012/no-multiple-blanks - Multiple consecutive blank lines",
369 "description": "Consecutive blank lines",
374 "additionalProperties": false
376 "no-multiple-blanks": {
377 "description": "MD012/no-multiple-blanks - Multiple consecutive blank lines",
385 "description": "Consecutive blank lines",
390 "additionalProperties": false
393 "description": "MD013/line-length - Line length",
401 "description": "Number of characters",
405 "heading_line_length": {
406 "description": "Number of characters for headings",
410 "code_block_line_length": {
411 "description": "Number of characters for code blocks",
416 "description": "Include code blocks",
421 "description": "Include tables",
426 "description": "Include headings",
431 "description": "Include headings",
436 "description": "Strict length checking",
441 "description": "Stern length checking",
446 "additionalProperties": false
449 "description": "MD013/line-length - Line length",
457 "description": "Number of characters",
461 "heading_line_length": {
462 "description": "Number of characters for headings",
466 "code_block_line_length": {
467 "description": "Number of characters for code blocks",
472 "description": "Include code blocks",
477 "description": "Include tables",
482 "description": "Include headings",
487 "description": "Include headings",
492 "description": "Strict length checking",
497 "description": "Stern length checking",
502 "additionalProperties": false
505 "description": "MD014/commands-show-output - Dollar signs used before commands without showing output",
509 "commands-show-output": {
510 "description": "MD014/commands-show-output - Dollar signs used before commands without showing output",
515 "description": "MD018/no-missing-space-atx - No space after hash on atx style heading",
519 "no-missing-space-atx": {
520 "description": "MD018/no-missing-space-atx - No space after hash on atx style heading",
525 "description": "MD019/no-multiple-space-atx - Multiple spaces after hash on atx style heading",
529 "no-multiple-space-atx": {
530 "description": "MD019/no-multiple-space-atx - Multiple spaces after hash on atx style heading",
535 "description": "MD020/no-missing-space-closed-atx - No space inside hashes on closed atx style heading",
539 "no-missing-space-closed-atx": {
540 "description": "MD020/no-missing-space-closed-atx - No space inside hashes on closed atx style heading",
545 "description": "MD021/no-multiple-space-closed-atx - Multiple spaces inside hashes on closed atx style heading",
549 "no-multiple-space-closed-atx": {
550 "description": "MD021/no-multiple-space-closed-atx - Multiple spaces inside hashes on closed atx style heading",
555 "description": "MD022/blanks-around-headings/blanks-around-headers - Headings should be surrounded by blank lines",
563 "description": "Blank lines above heading",
568 "description": "Blank lines below heading",
573 "additionalProperties": false
575 "blanks-around-headings": {
576 "description": "MD022/blanks-around-headings/blanks-around-headers - Headings should be surrounded by blank lines",
584 "description": "Blank lines above heading",
589 "description": "Blank lines below heading",
594 "additionalProperties": false
596 "blanks-around-headers": {
597 "description": "MD022/blanks-around-headings/blanks-around-headers - Headings should be surrounded by blank lines",
605 "description": "Blank lines above heading",
610 "description": "Blank lines below heading",
615 "additionalProperties": false
618 "description": "MD023/heading-start-left/header-start-left - Headings must start at the beginning of the line",
622 "heading-start-left": {
623 "description": "MD023/heading-start-left/header-start-left - Headings must start at the beginning of the line",
627 "header-start-left": {
628 "description": "MD023/heading-start-left/header-start-left - Headings must start at the beginning of the line",
633 "description": "MD024/no-duplicate-heading/no-duplicate-header - Multiple headings with the same content",
640 "allow_different_nesting": {
641 "description": "Only check sibling headings",
646 "description": "Only check sibling headings",
651 "additionalProperties": false
653 "no-duplicate-heading": {
654 "description": "MD024/no-duplicate-heading/no-duplicate-header - Multiple headings with the same content",
661 "allow_different_nesting": {
662 "description": "Only check sibling headings",
667 "description": "Only check sibling headings",
672 "additionalProperties": false
674 "no-duplicate-header": {
675 "description": "MD024/no-duplicate-heading/no-duplicate-header - Multiple headings with the same content",
682 "allow_different_nesting": {
683 "description": "Only check sibling headings",
688 "description": "Only check sibling headings",
693 "additionalProperties": false
696 "description": "MD025/single-title/single-h1 - Multiple top-level headings in the same document",
704 "description": "Heading level",
708 "front_matter_title": {
709 "description": "RegExp for matching title in front matter",
711 "default": "^\\s*title\\s*[:=]"
714 "additionalProperties": false
717 "description": "MD025/single-title/single-h1 - Multiple top-level headings in the same document",
725 "description": "Heading level",
729 "front_matter_title": {
730 "description": "RegExp for matching title in front matter",
732 "default": "^\\s*title\\s*[:=]"
735 "additionalProperties": false
738 "description": "MD025/single-title/single-h1 - Multiple top-level headings in the same document",
746 "description": "Heading level",
750 "front_matter_title": {
751 "description": "RegExp for matching title in front matter",
753 "default": "^\\s*title\\s*[:=]"
756 "additionalProperties": false
759 "description": "MD026/no-trailing-punctuation - Trailing punctuation in heading",
767 "description": "Punctuation characters",
769 "default": ".,;:!。,;:!"
772 "additionalProperties": false
774 "no-trailing-punctuation": {
775 "description": "MD026/no-trailing-punctuation - Trailing punctuation in heading",
783 "description": "Punctuation characters",
785 "default": ".,;:!。,;:!"
788 "additionalProperties": false
791 "description": "MD027/no-multiple-space-blockquote - Multiple spaces after blockquote symbol",
795 "no-multiple-space-blockquote": {
796 "description": "MD027/no-multiple-space-blockquote - Multiple spaces after blockquote symbol",
801 "description": "MD028/no-blanks-blockquote - Blank line inside blockquote",
805 "no-blanks-blockquote": {
806 "description": "MD028/no-blanks-blockquote - Blank line inside blockquote",
811 "description": "MD029/ol-prefix - Ordered list item prefix",
819 "description": "List style",
827 "default": "one_or_ordered"
830 "additionalProperties": false
833 "description": "MD029/ol-prefix - Ordered list item prefix",
841 "description": "List style",
849 "default": "one_or_ordered"
852 "additionalProperties": false
855 "description": "MD030/list-marker-space - Spaces after list markers",
863 "description": "Spaces for single-line unordered list items",
868 "description": "Spaces for single-line ordered list items",
873 "description": "Spaces for multi-line unordered list items",
878 "description": "Spaces for multi-line ordered list items",
883 "additionalProperties": false
885 "list-marker-space": {
886 "description": "MD030/list-marker-space - Spaces after list markers",
894 "description": "Spaces for single-line unordered list items",
899 "description": "Spaces for single-line ordered list items",
904 "description": "Spaces for multi-line unordered list items",
909 "description": "Spaces for multi-line ordered list items",
914 "additionalProperties": false
917 "description": "MD031/blanks-around-fences - Fenced code blocks should be surrounded by blank lines",
925 "description": "Include list items",
930 "additionalProperties": false
932 "blanks-around-fences": {
933 "description": "MD031/blanks-around-fences - Fenced code blocks should be surrounded by blank lines",
941 "description": "Include list items",
946 "additionalProperties": false
949 "description": "MD032/blanks-around-lists - Lists should be surrounded by blank lines",
953 "blanks-around-lists": {
954 "description": "MD032/blanks-around-lists - Lists should be surrounded by blank lines",
959 "description": "MD033/no-inline-html - Inline HTML",
966 "allowed_elements": {
967 "description": "Allowed elements",
975 "additionalProperties": false
978 "description": "MD033/no-inline-html - Inline HTML",
985 "allowed_elements": {
986 "description": "Allowed elements",
994 "additionalProperties": false
997 "description": "MD034/no-bare-urls - Bare URL used",
1002 "description": "MD034/no-bare-urls - Bare URL used",
1007 "description": "MD035/hr-style - Horizontal rule style",
1015 "description": "Horizontal rule style",
1017 "default": "consistent"
1020 "additionalProperties": false
1023 "description": "MD035/hr-style - Horizontal rule style",
1031 "description": "Horizontal rule style",
1033 "default": "consistent"
1036 "additionalProperties": false
1039 "description": "MD036/no-emphasis-as-heading/no-emphasis-as-header - Emphasis used instead of a heading",
1047 "description": "Punctuation characters",
1049 "default": ".,;:!?。,;:!?"
1052 "additionalProperties": false
1054 "no-emphasis-as-heading": {
1055 "description": "MD036/no-emphasis-as-heading/no-emphasis-as-header - Emphasis used instead of a heading",
1063 "description": "Punctuation characters",
1065 "default": ".,;:!?。,;:!?"
1068 "additionalProperties": false
1070 "no-emphasis-as-header": {
1071 "description": "MD036/no-emphasis-as-heading/no-emphasis-as-header - Emphasis used instead of a heading",
1079 "description": "Punctuation characters",
1081 "default": ".,;:!?。,;:!?"
1084 "additionalProperties": false
1087 "description": "MD037/no-space-in-emphasis - Spaces inside emphasis markers",
1091 "no-space-in-emphasis": {
1092 "description": "MD037/no-space-in-emphasis - Spaces inside emphasis markers",
1097 "description": "MD038/no-space-in-code - Spaces inside code span elements",
1101 "no-space-in-code": {
1102 "description": "MD038/no-space-in-code - Spaces inside code span elements",
1107 "description": "MD039/no-space-in-links - Spaces inside link text",
1111 "no-space-in-links": {
1112 "description": "MD039/no-space-in-links - Spaces inside link text",
1117 "description": "MD040/fenced-code-language - Fenced code blocks should have a language specified",
1121 "fenced-code-language": {
1122 "description": "MD040/fenced-code-language - Fenced code blocks should have a language specified",
1127 "description": "MD041/first-line-heading/first-line-h1 - First line in a file should be a top-level heading",
1135 "description": "Heading level",
1139 "front_matter_title": {
1140 "description": "RegExp for matching title in front matter",
1142 "default": "^\\s*title\\s*[:=]"
1145 "additionalProperties": false
1147 "first-line-heading": {
1148 "description": "MD041/first-line-heading/first-line-h1 - First line in a file should be a top-level heading",
1156 "description": "Heading level",
1160 "front_matter_title": {
1161 "description": "RegExp for matching title in front matter",
1163 "default": "^\\s*title\\s*[:=]"
1166 "additionalProperties": false
1169 "description": "MD041/first-line-heading/first-line-h1 - First line in a file should be a top-level heading",
1177 "description": "Heading level",
1181 "front_matter_title": {
1182 "description": "RegExp for matching title in front matter",
1184 "default": "^\\s*title\\s*[:=]"
1187 "additionalProperties": false
1190 "description": "MD042/no-empty-links - No empty links",
1195 "description": "MD042/no-empty-links - No empty links",
1200 "description": "MD043/required-headings/required-headers - Required heading structure",
1208 "description": "List of headings",
1216 "description": "List of headings",
1224 "additionalProperties": false
1226 "required-headings": {
1227 "description": "MD043/required-headings/required-headers - Required heading structure",
1235 "description": "List of headings",
1243 "description": "List of headings",
1251 "additionalProperties": false
1253 "required-headers": {
1254 "description": "MD043/required-headings/required-headers - Required heading structure",
1262 "description": "List of headings",
1270 "description": "List of headings",
1278 "additionalProperties": false
1281 "description": "MD044/proper-names - Proper names should have the correct capitalization",
1289 "description": "List of proper names",
1297 "description": "Include code blocks",
1302 "additionalProperties": false
1305 "description": "MD044/proper-names - Proper names should have the correct capitalization",
1313 "description": "List of proper names",
1321 "description": "Include code blocks",
1326 "additionalProperties": false
1329 "description": "MD045/no-alt-text - Images should have alternate text (alt text)",
1334 "description": "MD045/no-alt-text - Images should have alternate text (alt text)",
1339 "description": "MD046/code-block-style - Code block style",
1347 "description": "Block style",
1354 "default": "consistent"
1357 "additionalProperties": false
1359 "code-block-style": {
1360 "description": "MD046/code-block-style - Code block style",
1368 "description": "Block style",
1375 "default": "consistent"
1378 "additionalProperties": false
1381 "description": "MD047/single-trailing-newline - Files should end with a single newline character",
1385 "single-trailing-newline": {
1386 "description": "MD047/single-trailing-newline - Files should end with a single newline character",
1391 "description": "MD048/code-fence-style - Code fence style",
1399 "description": "Code fence syle",
1406 "default": "consistent"
1409 "additionalProperties": false
1411 "code-fence-style": {
1412 "description": "MD048/code-fence-style - Code fence style",
1420 "description": "Code fence syle",
1427 "default": "consistent"
1430 "additionalProperties": false
1433 "description": "headings - MD001, MD002, MD003, MD018, MD019, MD020, MD021, MD022, MD023, MD024, MD025, MD026, MD036, MD041, MD043",
1438 "description": "headers - MD001, MD002, MD003, MD018, MD019, MD020, MD021, MD022, MD023, MD024, MD025, MD026, MD036, MD041, MD043",
1443 "description": "bullet - MD004, MD005, MD006, MD007, MD032",
1448 "description": "ul - MD004, MD005, MD006, MD007, MD030, MD032",
1453 "description": "indentation - MD005, MD006, MD007, MD027",
1458 "description": "whitespace - MD009, MD010, MD012, MD027, MD028, MD030, MD037, MD038, MD039",
1463 "description": "hard_tab - MD010",
1468 "description": "links - MD011, MD034, MD039, MD042",
1473 "description": "blank_lines - MD012, MD022, MD031, MD032, MD047",
1478 "description": "line_length - MD013",
1483 "description": "code - MD014, MD031, MD038, MD040, MD046, MD048",
1488 "description": "atx - MD018, MD019",
1493 "description": "spaces - MD018, MD019, MD020, MD021, MD023",
1498 "description": "atx_closed - MD020, MD021",
1503 "description": "blockquote - MD027, MD028",
1508 "description": "ol - MD029, MD030, MD032",
1513 "description": "html - MD033",
1518 "description": "url - MD034",
1523 "description": "hr - MD035",
1528 "description": "emphasis - MD036, MD037",
1533 "description": "language - MD040",
1538 "description": "spelling - MD044",
1543 "description": "accessibility - MD045",
1548 "description": "images - MD045",
1553 "additionalProperties": {