2023-02-21 00:04:05 +01:00
// Example markdownlint configuration with all properties set to their default value
2021-01-19 20:41:04 -08:00
{
// Default state for all rules
"default" : true ,
// Path to configuration file to extend
"extends" : null ,
2025-01-14 23:39:35 -08:00
// MD001/heading-increment : Heading levels should only increment by one level at a time : https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md001.md
2021-01-19 20:41:04 -08:00
"MD001" : true ,
2025-01-14 23:39:35 -08:00
// MD003/heading-style : Heading style : https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md003.md
2021-01-19 20:41:04 -08:00
"MD003" : {
// Heading style
"style" : "consistent"
} ,
2025-01-14 23:39:35 -08:00
// MD004/ul-style : Unordered list style : https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md004.md
2021-01-19 20:41:04 -08:00
"MD004" : {
// List style
"style" : "consistent"
} ,
2025-01-14 23:39:35 -08:00
// MD005/list-indent : Inconsistent indentation for list items at the same level : https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md005.md
2021-01-19 20:41:04 -08:00
"MD005" : true ,
2025-01-14 23:39:35 -08:00
// MD007/ul-indent : Unordered list indentation : https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md007.md
2021-01-19 20:41:04 -08:00
"MD007" : {
// Spaces for indent
"indent" : 2 ,
// Whether to indent the first level of the list
2021-12-13 21:49:43 -08:00
"start_indented" : false ,
// Spaces for first level indent (when start_indented is set)
"start_indent" : 2
2021-01-19 20:41:04 -08:00
} ,
2025-01-14 23:39:35 -08:00
// MD009/no-trailing-spaces : Trailing spaces : https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md009.md
2021-01-19 20:41:04 -08:00
"MD009" : {
// Spaces for line break
"br_spaces" : 2 ,
// Allow spaces for empty lines in list items
"list_item_empty_lines" : false ,
// Include unnecessary breaks
"strict" : false
} ,
2025-01-14 23:39:35 -08:00
// MD010/no-hard-tabs : Hard tabs : https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md010.md
2021-01-19 20:41:04 -08:00
"MD010" : {
// Include code blocks
2021-04-09 16:33:01 -07:00
"code_blocks" : true ,
2022-04-28 21:09:06 -07:00
// Fenced code languages to ignore
"ignore_code_languages" : [ ] ,
2021-04-09 16:33:01 -07:00
// Number of spaces for each hard tab
"spaces_per_tab" : 1
2021-01-19 20:41:04 -08:00
} ,
2025-01-14 23:39:35 -08:00
// MD011/no-reversed-links : Reversed link syntax : https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md011.md
2021-01-19 20:41:04 -08:00
"MD011" : true ,
2025-01-14 23:39:35 -08:00
// MD012/no-multiple-blanks : Multiple consecutive blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md012.md
2021-01-19 20:41:04 -08:00
"MD012" : {
// Consecutive blank lines
"maximum" : 1
} ,
2025-01-14 23:39:35 -08:00
// MD013/line-length : Line length : https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md013.md
2021-01-19 20:41:04 -08:00
"MD013" : {
// Number of characters
"line_length" : 80 ,
// Number of characters for headings
"heading_line_length" : 80 ,
// Number of characters for code blocks
"code_block_line_length" : 80 ,
// Include code blocks
"code_blocks" : true ,
// Include tables
"tables" : true ,
// Include headings
"headings" : true ,
// Strict length checking
"strict" : false ,
// Stern length checking
"stern" : false
} ,
2025-01-14 23:39:35 -08:00
// MD014/commands-show-output : Dollar signs used before commands without showing output : https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md014.md
2021-01-19 20:41:04 -08:00
"MD014" : true ,
2025-01-14 23:39:35 -08:00
// MD018/no-missing-space-atx : No space after hash on atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md018.md
2021-01-19 20:41:04 -08:00
"MD018" : true ,
2025-01-14 23:39:35 -08:00
// MD019/no-multiple-space-atx : Multiple spaces after hash on atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md019.md
2021-01-19 20:41:04 -08:00
"MD019" : true ,
2025-01-14 23:39:35 -08:00
// MD020/no-missing-space-closed-atx : No space inside hashes on closed atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md020.md
2021-01-19 20:41:04 -08:00
"MD020" : true ,
2025-01-14 23:39:35 -08:00
// MD021/no-multiple-space-closed-atx : Multiple spaces inside hashes on closed atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md021.md
2021-01-19 20:41:04 -08:00
"MD021" : true ,
2025-01-14 23:39:35 -08:00
// MD022/blanks-around-headings : Headings should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md022.md
2021-01-19 20:41:04 -08:00
"MD022" : {
// Blank lines above heading
"lines_above" : 1 ,
// Blank lines below heading
"lines_below" : 1
} ,
2025-01-14 23:39:35 -08:00
// MD023/heading-start-left : Headings must start at the beginning of the line : https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md023.md
2021-01-19 20:41:04 -08:00
"MD023" : true ,
2025-01-14 23:39:35 -08:00
// MD024/no-duplicate-heading : Multiple headings with the same content : https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md024.md
2021-01-19 20:41:04 -08:00
"MD024" : {
// Only check sibling headings
"siblings_only" : false
} ,
2025-01-14 23:39:35 -08:00
// MD025/single-title/single-h1 : Multiple top-level headings in the same document : https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md025.md
2021-01-19 20:41:04 -08:00
"MD025" : {
// RegExp for matching title in front matter
2025-03-22 16:15:59 -07:00
"front_matter_title" : "^\\s*title\\s*[:=]" ,
// Heading level
"level" : 1
2021-01-19 20:41:04 -08:00
} ,
2025-01-14 23:39:35 -08:00
// MD026/no-trailing-punctuation : Trailing punctuation in heading : https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md026.md
2021-01-19 20:41:04 -08:00
"MD026" : {
2023-07-29 15:20:10 -07:00
// Punctuation characters
2021-01-19 20:41:04 -08:00
"punctuation" : ".,;:!。,;:!"
} ,
2025-01-14 23:39:35 -08:00
// MD027/no-multiple-space-blockquote : Multiple spaces after blockquote symbol : https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md027.md
2025-03-03 23:22:28 -08:00
"MD027" : {
// Include list items
"list_items" : true
} ,
2021-01-19 20:41:04 -08:00
2025-01-14 23:39:35 -08:00
// MD028/no-blanks-blockquote : Blank line inside blockquote : https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md028.md
2021-01-19 20:41:04 -08:00
"MD028" : true ,
2025-01-14 23:39:35 -08:00
// MD029/ol-prefix : Ordered list item prefix : https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md029.md
2021-01-19 20:41:04 -08:00
"MD029" : {
// List style
"style" : "one_or_ordered"
} ,
2025-01-14 23:39:35 -08:00
// MD030/list-marker-space : Spaces after list markers : https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md030.md
2021-01-19 20:41:04 -08:00
"MD030" : {
// Spaces for single-line unordered list items
"ul_single" : 1 ,
// Spaces for single-line ordered list items
"ol_single" : 1 ,
// Spaces for multi-line unordered list items
"ul_multi" : 1 ,
// Spaces for multi-line ordered list items
"ol_multi" : 1
} ,
2025-01-14 23:39:35 -08:00
// MD031/blanks-around-fences : Fenced code blocks should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md031.md
2021-01-19 20:41:04 -08:00
"MD031" : {
// Include list items
"list_items" : true
} ,
2025-01-14 23:39:35 -08:00
// MD032/blanks-around-lists : Lists should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md032.md
2021-01-19 20:41:04 -08:00
"MD032" : true ,
2025-01-14 23:39:35 -08:00
// MD033/no-inline-html : Inline HTML : https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md033.md
2021-01-19 20:41:04 -08:00
"MD033" : {
// Allowed elements
"allowed_elements" : [ ]
} ,
2025-01-14 23:39:35 -08:00
// MD034/no-bare-urls : Bare URL used : https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md034.md
2021-01-19 20:41:04 -08:00
"MD034" : true ,
2025-01-14 23:39:35 -08:00
// MD035/hr-style : Horizontal rule style : https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md035.md
2021-01-19 20:41:04 -08:00
"MD035" : {
// Horizontal rule style
"style" : "consistent"
} ,
2025-01-14 23:39:35 -08:00
// MD036/no-emphasis-as-heading : Emphasis used instead of a heading : https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md036.md
2021-01-19 20:41:04 -08:00
"MD036" : {
// Punctuation characters
"punctuation" : ".,;:!?。,;:!?"
} ,
2025-01-14 23:39:35 -08:00
// MD037/no-space-in-emphasis : Spaces inside emphasis markers : https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md037.md
2021-01-19 20:41:04 -08:00
"MD037" : true ,
2025-01-14 23:39:35 -08:00
// MD038/no-space-in-code : Spaces inside code span elements : https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md038.md
2021-01-19 20:41:04 -08:00
"MD038" : true ,
2025-01-14 23:39:35 -08:00
// MD039/no-space-in-links : Spaces inside link text : https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md039.md
2021-01-19 20:41:04 -08:00
"MD039" : true ,
2025-01-14 23:39:35 -08:00
// MD040/fenced-code-language : Fenced code blocks should have a language specified : https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md040.md
2022-10-18 03:29:29 +08:00
"MD040" : {
// List of languages
2022-11-11 07:07:04 +01:00
"allowed_languages" : [ ] ,
// Require language only
"language_only" : false
2022-10-18 03:29:29 +08:00
} ,
2021-01-19 20:41:04 -08:00
2025-01-14 23:39:35 -08:00
// 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.37.4/doc/md041.md
2021-01-19 20:41:04 -08:00
"MD041" : {
2025-03-22 16:15:59 -07:00
// Allow content before first heading
"allow_preamble" : false ,
2021-01-19 20:41:04 -08:00
// RegExp for matching title in front matter
2025-03-22 16:15:59 -07:00
"front_matter_title" : "^\\s*title\\s*[:=]" ,
// Heading level
"level" : 1
2021-01-19 20:41:04 -08:00
} ,
2025-01-14 23:39:35 -08:00
// MD042/no-empty-links : No empty links : https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md042.md
2021-01-19 20:41:04 -08:00
"MD042" : true ,
2025-01-14 23:39:35 -08:00
// MD043/required-headings : Required heading structure : https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md043.md
2021-01-19 20:41:04 -08:00
"MD043" : {
// List of headings
"headings" : [ ] ,
2022-10-22 03:15:50 -04:00
// Match case of headings
"match_case" : false
2021-01-19 20:41:04 -08:00
} ,
2025-01-14 23:39:35 -08:00
// MD044/proper-names : Proper names should have the correct capitalization : https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md044.md
2021-01-19 20:41:04 -08:00
"MD044" : {
// List of proper names
"names" : [ ] ,
// Include code blocks
2022-04-25 21:50:33 -07:00
"code_blocks" : true ,
// Include HTML elements
"html_elements" : true
2021-01-19 20:41:04 -08:00
} ,
2025-01-14 23:39:35 -08:00
// MD045/no-alt-text : Images should have alternate text (alt text) : https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md045.md
2021-01-19 20:41:04 -08:00
"MD045" : true ,
2025-01-14 23:39:35 -08:00
// MD046/code-block-style : Code block style : https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md046.md
2021-01-19 20:41:04 -08:00
"MD046" : {
// Block style
"style" : "consistent"
} ,
2025-01-14 23:39:35 -08:00
// MD047/single-trailing-newline : Files should end with a single newline character : https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md047.md
2021-01-19 20:41:04 -08:00
"MD047" : true ,
2025-01-14 23:39:35 -08:00
// MD048/code-fence-style : Code fence style : https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md048.md
2021-01-19 20:41:04 -08:00
"MD048" : {
2021-05-14 08:45:14 -07:00
// Code fence style
2021-01-19 20:41:04 -08:00
"style" : "consistent"
2021-10-21 06:42:48 +02:00
} ,
2025-01-14 23:39:35 -08:00
// MD049/emphasis-style : Emphasis style : https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md049.md
2021-10-24 06:54:58 +02:00
"MD049" : {
2023-07-29 15:20:10 -07:00
// Emphasis style
2021-10-24 06:54:58 +02:00
"style" : "consistent"
} ,
2025-01-14 23:39:35 -08:00
// MD050/strong-style : Strong style : https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md050.md
2021-10-21 06:42:48 +02:00
"MD050" : {
2023-07-29 15:20:10 -07:00
// Strong style
2021-10-21 06:42:48 +02:00
"style" : "consistent"
2022-01-26 00:21:08 +01:00
} ,
2025-01-14 23:39:35 -08:00
// MD051/link-fragments : Link fragments should be valid : https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md051.md
2024-10-08 22:40:11 -07:00
"MD051" : {
// Ignore case of fragments
2025-04-05 22:34:54 -07:00
"ignore_case" : false ,
// Pattern for ignoring additional fragments
"ignored_pattern" : ""
2024-10-08 22:40:11 -07:00
} ,
2022-06-01 20:23:08 -07:00
2025-01-14 23:39:35 -08:00
// MD052/reference-links-images : Reference links and images should use a label that is defined : https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md052.md
2023-09-04 16:40:48 -07:00
"MD052" : {
2025-04-27 22:36:07 -07:00
// Ignored link labels
"ignored_labels" : [
"x"
] ,
2023-09-04 16:40:48 -07:00
// Include shortcut syntax
"shortcut_syntax" : false
} ,
2022-06-01 20:23:08 -07:00
2025-01-14 23:39:35 -08:00
// MD053/link-image-reference-definitions : Link and image reference definitions should be needed : https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md053.md
2022-08-02 20:36:47 -07:00
"MD053" : {
// Ignored definitions
"ignored_definitions" : [
"//"
]
2023-10-25 20:05:19 -07:00
} ,
2025-01-14 23:39:35 -08:00
// MD054/link-image-style : Link and image style : https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md054.md
2023-10-25 20:05:19 -07:00
"MD054" : {
// Allow autolinks
"autolink" : true ,
// Allow inline links and images
"inline" : true ,
2023-11-11 22:12:50 -08:00
// Allow full reference links and images
"full" : true ,
// Allow collapsed reference links and images
"collapsed" : true ,
// Allow shortcut reference links and images
2023-11-12 22:42:02 -08:00
"shortcut" : true ,
// Allow URLs as inline links
"url_inline" : true
2023-12-30 18:15:38 -08:00
} ,
2025-01-14 23:39:35 -08:00
// MD055/table-pipe-style : Table pipe style : https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md055.md
2023-12-30 18:15:38 -08:00
"MD055" : {
// Table pipe style
"style" : "consistent"
2024-01-04 23:07:55 -08:00
} ,
2025-01-14 23:39:35 -08:00
// MD056/table-column-count : Table column count : https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md056.md
2024-06-01 21:32:10 -07:00
"MD056" : true ,
2025-01-14 23:39:35 -08:00
// MD058/blanks-around-tables : Tables should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md058.md
2025-01-06 11:35:17 -05:00
"MD058" : true ,
// MD059/descriptive-link-text : Link text should be descriptive : https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md059.md
"MD059" : {
2025-02-13 22:07:27 -08:00
// Prohibited link texts
"prohibited_texts" : [
"click here" ,
"here" ,
"link" ,
"more"
]
2025-01-06 11:35:17 -05:00
}
2021-01-19 20:41:04 -08:00
}