Andreas/markdownlint
1
0
Fork 0
mirror of https://github.com/DavidAnson/markdownlint.git synced 2025-12-16 22:10:13 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Add rule information links to JSON schema for configuration files and corresponding examples (link is clickable in VS Code tooltips).

Browse source
This commit is contained in:
David Anson 2023-11-03 20:23:13 -07:00
parent 1a376f60bb
commit 18497ff03c
4 changed files with 177 additions and 176 deletions
Download patch file Download diff file Expand all files Collapse all files

100
schema/.markdownlint.jsonc
View file

@ -7,34 +7,34 @@
// Path to configuration file to extend
"extends": null,
// MD001/heading-increment/header-increment - Heading levels should only increment by one level at a time
// MD001/heading-increment/header-increment : Heading levels should only increment by one level at a time : https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md001.md
"MD001": true,
// MD002/first-heading-h1/first-header-h1 - First heading should be a top-level heading
// MD002/first-heading-h1/first-header-h1 : First heading should be a top-level heading : https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md002.md
"MD002": {
// Heading level
"level": 1
},
// MD003/heading-style/header-style - Heading style
// MD003/heading-style/header-style : Heading style : https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md003.md
"MD003": {
// Heading style
"style": "consistent"
},
// MD004/ul-style - Unordered list style
// MD004/ul-style : Unordered list style : https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md004.md
"MD004": {
// List style
"style": "consistent"
},
// MD005/list-indent - Inconsistent indentation for list items at the same level
// MD005/list-indent : Inconsistent indentation for list items at the same level : https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md005.md
"MD005": true,
// MD006/ul-start-left - Consider starting bulleted lists at the beginning of the line
// MD006/ul-start-left : Consider starting bulleted lists at the beginning of the line : https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md006.md
"MD006": true,
// MD007/ul-indent - Unordered list indentation
// MD007/ul-indent : Unordered list indentation : https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md007.md
"MD007": {
// Spaces for indent
"indent": 2,
@ -44,7 +44,7 @@
"start_indent": 2
},
// MD009/no-trailing-spaces - Trailing spaces
// MD009/no-trailing-spaces : Trailing spaces : https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md009.md
"MD009": {
// Spaces for line break
"br_spaces": 2,
@ -54,7 +54,7 @@
"strict": false
},
// MD010/no-hard-tabs - Hard tabs
// MD010/no-hard-tabs : Hard tabs : https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md010.md
"MD010": {
// Include code blocks
"code_blocks": true,
@ -64,16 +64,16 @@
"spaces_per_tab": 1
},
// MD011/no-reversed-links - Reversed link syntax
// MD011/no-reversed-links : Reversed link syntax : https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md011.md
"MD011": true,
// MD012/no-multiple-blanks - Multiple consecutive blank lines
// MD012/no-multiple-blanks : Multiple consecutive blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md012.md
"MD012": {
// Consecutive blank lines
"maximum": 1
},
// MD013/line-length - Line length
// MD013/line-length : Line length : https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md013.md
"MD013": {
// Number of characters
"line_length": 80,
@ -95,22 +95,22 @@
"stern": false
},
// MD014/commands-show-output - Dollar signs used before commands without showing output
// MD014/commands-show-output : Dollar signs used before commands without showing output : https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md014.md
"MD014": true,
// MD018/no-missing-space-atx - No space after hash on atx style heading
// MD018/no-missing-space-atx : No space after hash on atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md018.md
"MD018": true,
// MD019/no-multiple-space-atx - Multiple spaces after hash on atx style heading
// MD019/no-multiple-space-atx : Multiple spaces after hash on atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md019.md
"MD019": true,
// MD020/no-missing-space-closed-atx - No space inside hashes on closed atx style heading
// MD020/no-missing-space-closed-atx : No space inside hashes on closed atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md020.md
"MD020": true,
// MD021/no-multiple-space-closed-atx - Multiple spaces inside hashes on closed atx style heading
// MD021/no-multiple-space-closed-atx : Multiple spaces inside hashes on closed atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md021.md
"MD021": true,
// MD022/blanks-around-headings/blanks-around-headers - Headings should be surrounded by blank lines
// MD022/blanks-around-headings/blanks-around-headers : Headings should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md022.md
"MD022": {
// Blank lines above heading
"lines_above": 1,
@ -118,10 +118,10 @@
"lines_below": 1
},
// MD023/heading-start-left/header-start-left - Headings must start at the beginning of the line
// MD023/heading-start-left/header-start-left : Headings must start at the beginning of the line : https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md023.md
"MD023": true,
// MD024/no-duplicate-heading/no-duplicate-header - Multiple headings with the same content
// MD024/no-duplicate-heading/no-duplicate-header : Multiple headings with the same content : https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md024.md
"MD024": {
// Only check sibling headings
"allow_different_nesting": false,
@ -129,7 +129,7 @@
"siblings_only": false
},
// MD025/single-title/single-h1 - Multiple top-level headings in the same document
// MD025/single-title/single-h1 : Multiple top-level headings in the same document : https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md025.md
"MD025": {
// Heading level
"level": 1,
@ -137,25 +137,25 @@
"front_matter_title": "^\\s*title\\s*[:=]"
},
// MD026/no-trailing-punctuation - Trailing punctuation in heading
// MD026/no-trailing-punctuation : Trailing punctuation in heading : https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md026.md
"MD026": {
// Punctuation characters
"punctuation": ".,;:!。，；：！"
},
// MD027/no-multiple-space-blockquote - Multiple spaces after blockquote symbol
// MD027/no-multiple-space-blockquote : Multiple spaces after blockquote symbol : https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md027.md
"MD027": true,
// MD028/no-blanks-blockquote - Blank line inside blockquote
// MD028/no-blanks-blockquote : Blank line inside blockquote : https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md028.md
"MD028": true,
// MD029/ol-prefix - Ordered list item prefix
// MD029/ol-prefix : Ordered list item prefix : https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md029.md
"MD029": {
// List style
"style": "one_or_ordered"
},
// MD030/list-marker-space - Spaces after list markers
// MD030/list-marker-space : Spaces after list markers : https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md030.md
"MD030": {
// Spaces for single-line unordered list items
"ul_single": 1,
@ -167,46 +167,46 @@
"ol_multi": 1
},
// MD031/blanks-around-fences - Fenced code blocks should be surrounded by blank lines
// MD031/blanks-around-fences : Fenced code blocks should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md031.md
"MD031": {
// Include list items
"list_items": true
},
// MD032/blanks-around-lists - Lists should be surrounded by blank lines
// MD032/blanks-around-lists : Lists should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md032.md
"MD032": true,
// MD033/no-inline-html - Inline HTML
// MD033/no-inline-html : Inline HTML : https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md033.md
"MD033": {
// Allowed elements
"allowed_elements": []
},
// MD034/no-bare-urls - Bare URL used
// MD034/no-bare-urls : Bare URL used : https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md034.md
"MD034": true,
// MD035/hr-style - Horizontal rule style
// MD035/hr-style : Horizontal rule style : https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md035.md
"MD035": {
// Horizontal rule style
"style": "consistent"
},
// MD036/no-emphasis-as-heading/no-emphasis-as-header - Emphasis used instead of a heading
// MD036/no-emphasis-as-heading/no-emphasis-as-header : Emphasis used instead of a heading : https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md036.md
"MD036": {
// Punctuation characters
"punctuation": ".,;:!?。，；：！？"
},
// MD037/no-space-in-emphasis - Spaces inside emphasis markers
// MD037/no-space-in-emphasis : Spaces inside emphasis markers : https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md037.md
"MD037": true,
// MD038/no-space-in-code - Spaces inside code span elements
// MD038/no-space-in-code : Spaces inside code span elements : https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md038.md
"MD038": true,
// MD039/no-space-in-links - Spaces inside link text
// MD039/no-space-in-links : Spaces inside link text : https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md039.md
"MD039": true,
// MD040/fenced-code-language - Fenced code blocks should have a language specified
// MD040/fenced-code-language : Fenced code blocks should have a language specified : https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md040.md
"MD040": {
// List of languages
"allowed_languages": [],
@ -214,7 +214,7 @@
"language_only": false
},
// MD041/first-line-heading/first-line-h1 - First line in a file should be a top-level heading
// 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.31.1/doc/md041.md
"MD041": {
// Heading level
"level": 1,
@ -222,10 +222,10 @@
"front_matter_title": "^\\s*title\\s*[:=]"
},
// MD042/no-empty-links - No empty links
// MD042/no-empty-links : No empty links : https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md042.md
"MD042": true,
// MD043/required-headings/required-headers - Required heading structure
// MD043/required-headings/required-headers : Required heading structure : https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md043.md
"MD043": {
// List of headings
"headings": [],
@ -235,7 +235,7 @@
"match_case": false
},
// MD044/proper-names - Proper names should have the correct capitalization
// MD044/proper-names : Proper names should have the correct capitalization : https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md044.md
"MD044": {
// List of proper names
"names": [],
@ -245,46 +245,46 @@
"html_elements": true
},
// MD045/no-alt-text - Images should have alternate text (alt text)
// MD045/no-alt-text : Images should have alternate text (alt text) : https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md045.md
"MD045": true,
// MD046/code-block-style - Code block style
// MD046/code-block-style : Code block style : https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md046.md
"MD046": {
// Block style
"style": "consistent"
},
// MD047/single-trailing-newline - Files should end with a single newline character
// MD047/single-trailing-newline : Files should end with a single newline character : https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md047.md
"MD047": true,
// MD048/code-fence-style - Code fence style
// MD048/code-fence-style : Code fence style : https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md048.md
"MD048": {
// Code fence style
"style": "consistent"
},
// MD049/emphasis-style - Emphasis style
// MD049/emphasis-style : Emphasis style : https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md049.md
"MD049": {
// Emphasis style
"style": "consistent"
},
// MD050/strong-style - Strong style
// MD050/strong-style : Strong style : https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md050.md
"MD050": {
// Strong style
"style": "consistent"
},
// MD051/link-fragments - Link fragments should be valid
// MD051/link-fragments : Link fragments should be valid : https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md051.md
"MD051": true,
// MD052/reference-links-images - Reference links and images should use a label that is defined
// MD052/reference-links-images : Reference links and images should use a label that is defined : https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md052.md
"MD052": {
// Include shortcut syntax
"shortcut_syntax": false
},
// MD053/link-image-reference-definitions - Link and image reference definitions should be needed
// MD053/link-image-reference-definitions : Link and image reference definitions should be needed : https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md053.md
"MD053": {
// Ignored definitions
"ignored_definitions": [
@ -292,7 +292,7 @@
]
},
// MD054/link-image-style - Link and image style
// MD054/link-image-style : Link and image style : https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md054.md
"MD054": {
// Allow autolinks
"autolink": true,