coc-markdownlint
Heyward FannMarkdownlint extension for coc.nvim
Published Package Summary
coc-markdownlint
markdownlint for Vim/Neovim, works as coc.nvim extension.
Features
- Style lint
- Autofix
<Plug>(coc-codeaction) on current diagnostic, you will find available codeAction, choose by number to fix.

Install
:CocInstall coc-markdownlint
Configurations
markdownlint.onOpen: lint on open a file, defaulttruemarkdownlint.onChange: lint on changing a file, defaulttruemarkdownlint.onSave: lint on saving a file, defaulttruemarkdownlint.config: configurations rules used by markdownlint, default{}
CodeActions
Provides codeAction for current file or line to disable markdownlint, triggered
by <Plug>(coc-codeaction) and <Plug>(coc-codeaction-line)
Rules
You can configures the markdownlint rules to use, for example:
{
"default": true,
"line_length": false
}
coc-markdownlint can read configurations from:
- Global configuration file that rc can find, for example
$HOME/.markdownlintrc. Checkoutrcfor more examples. markdownlint.configsection incoc-settings.json.markdownlint.{json, yaml}in local workspace root
License
MIT
This extension is created with create-coc-extension
- Markdownlint extension for coc.nvim
- onLanguage:markdown
Want to build, test, or contribute to coc.nvim extensions? Explore our official SDK and testing toolkits.
Open Developer GuideVersion History
This published npm package does not include a history.md or changelog.md file. Browse its npm versions or repository releases for available release information.
Contributed Commands
All contributes.commands entries from the published package manifest for coc-markdownlint@1.41.0.
| Command (:CocCommand) | Description |
|---|---|
| markdownlint.fixAll | Fix all errors found by markdownlint |
Configuration Schema
All contributes.configuration entries from the published package manifest, including each raw property schema for coc-settings.json.
Raw JSON Schema
{
"properties": {
"hr": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
}
],
"default": true,
"description": "hr : MD035"
},
"ol": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
}
],
"default": true,
"description": "ol : MD029, MD030, MD032"
},
"ul": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
}
],
"default": true,
"description": "ul : MD004, MD005, MD007, MD030, MD032"
},
"atx": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
}
],
"default": true,
"description": "atx : MD018, MD019"
},
"url": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
}
],
"default": true,
"description": "url : MD034"
},
"code": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
}
],
"default": true,
"description": "code : MD014, MD031, MD038, MD040, MD046, MD048"
},
"html": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
}
],
"default": true,
"description": "html : MD033"
},
"MD001": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
},
"front_matter_title": {
"type": "string",
"default": "^\\s*title\\s*[:=]",
"description": "RegExp for matching title in front matter"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD001/heading-increment : Heading levels should only increment by one level at a time : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md001.md"
},
"MD003": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"style": {
"enum": [
"consistent",
"atx",
"atx_closed",
"setext",
"setext_with_atx",
"setext_with_atx_closed"
],
"type": "string",
"default": "consistent",
"description": "Heading style"
},
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD003/heading-style : Heading style : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md003.md"
},
"MD004": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"style": {
"enum": [
"consistent",
"asterisk",
"plus",
"dash",
"sublist"
],
"type": "string",
"default": "consistent",
"description": "List style"
},
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD004/ul-style : Unordered list style : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md004.md"
},
"MD005": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD005/list-indent : Inconsistent indentation for list items at the same level : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md005.md"
},
"MD007": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"indent": {
"type": "integer",
"default": 2,
"minimum": 1,
"description": "Spaces for indent"
},
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
},
"start_indent": {
"type": "integer",
"default": 2,
"minimum": 1,
"description": "Spaces for first level indent (when start_indented is set)"
},
"start_indented": {
"type": "boolean",
"default": false,
"description": "Whether to indent the first level of the list"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD007/ul-indent : Unordered list indentation : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md007.md"
},
"MD009": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"strict": {
"type": "boolean",
"default": false,
"description": "Include unnecessary breaks"
},
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
},
"br_spaces": {
"type": "integer",
"default": 2,
"minimum": 0,
"description": "Spaces for line break"
},
"code_blocks": {
"type": "boolean",
"default": false,
"description": "Include code blocks"
},
"list_item_empty_lines": {
"type": "boolean",
"default": false,
"description": "Allow spaces for empty lines in list items"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD009/no-trailing-spaces : Trailing spaces : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md009.md"
},
"MD010": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
},
"code_blocks": {
"type": "boolean",
"default": true,
"description": "Include code blocks"
},
"spaces_per_tab": {
"type": "integer",
"default": 1,
"minimum": 0,
"description": "Number of spaces for each hard tab"
},
"ignore_code_languages": {
"type": "array",
"items": {
"type": "string"
},
"default": [],
"description": "Fenced code languages to ignore"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD010/no-hard-tabs : Hard tabs : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md010.md"
},
"MD011": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD011/no-reversed-links : Reversed link syntax : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md011.md"
},
"MD012": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"maximum": {
"type": "integer",
"default": 1,
"minimum": 1,
"description": "Consecutive blank lines"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD012/no-multiple-blanks : Multiple consecutive blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md012.md"
},
"MD013": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"stern": {
"type": "boolean",
"default": false,
"description": "Stern length checking"
},
"strict": {
"type": "boolean",
"default": false,
"description": "Strict length checking"
},
"tables": {
"type": "boolean",
"default": true,
"description": "Include tables"
},
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"headings": {
"type": "boolean",
"default": true,
"description": "Include headings"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
},
"code_blocks": {
"type": "boolean",
"default": true,
"description": "Include code blocks"
},
"line_length": {
"type": "integer",
"default": 80,
"minimum": 1,
"description": "Number of characters"
},
"heading_line_length": {
"type": "integer",
"default": 80,
"minimum": 1,
"description": "Number of characters for headings"
},
"code_block_line_length": {
"type": "integer",
"default": 80,
"minimum": 1,
"description": "Number of characters for code blocks"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD013/line-length : Line length : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md013.md"
},
"MD014": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD014/commands-show-output : Dollar signs used before commands without showing output : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md014.md"
},
"MD018": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD018/no-missing-space-atx : No space after hash on atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md018.md"
},
"MD019": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD019/no-multiple-space-atx : Multiple spaces after hash on atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md019.md"
},
"MD020": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD020/no-missing-space-closed-atx : No space inside hashes on closed atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md020.md"
},
"MD021": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD021/no-multiple-space-closed-atx : Multiple spaces inside hashes on closed atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md021.md"
},
"MD022": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
},
"lines_above": {
"type": [
"integer",
"array"
],
"items": {
"type": "integer"
},
"default": 1,
"minimum": -1,
"description": "Blank lines above heading"
},
"lines_below": {
"type": [
"integer",
"array"
],
"items": {
"type": "integer"
},
"default": 1,
"minimum": -1,
"description": "Blank lines below heading"
},
"include_front_matter": {
"type": "boolean",
"default": false,
"description": "Include front matter content"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD022/blanks-around-headings : Headings should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md022.md"
},
"MD023": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD023/heading-start-left : Headings must start at the beginning of the line : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md023.md"
},
"MD024": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
},
"siblings_only": {
"type": "boolean",
"default": false,
"description": "Only check sibling headings"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD024/no-duplicate-heading : Multiple headings with the same content : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md024.md"
},
"MD025": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"level": {
"type": "integer",
"default": 1,
"maximum": 6,
"minimum": 1,
"description": "Heading level"
},
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
},
"front_matter_title": {
"type": "string",
"default": "^\\s*title\\s*[:=]",
"description": "RegExp for matching title in front matter"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD025/single-title/single-h1 : Multiple top-level headings in the same document : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md025.md"
},
"MD026": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
},
"punctuation": {
"type": "string",
"default": ".,;:!。,;:!",
"description": "Punctuation characters"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD026/no-trailing-punctuation : Trailing punctuation in heading : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md026.md"
},
"MD027": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
},
"list_items": {
"type": "boolean",
"default": true,
"description": "Include list items"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD027/no-multiple-space-blockquote : Multiple spaces after blockquote symbol : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md027.md"
},
"MD028": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD028/no-blanks-blockquote : Blank line inside blockquote : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md028.md"
},
"MD029": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"style": {
"enum": [
"one",
"ordered",
"one_or_ordered",
"zero"
],
"type": "string",
"default": "one_or_ordered",
"description": "List style"
},
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD029/ol-prefix : Ordered list item prefix : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md029.md"
},
"MD030": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"ol_multi": {
"type": "integer",
"default": 1,
"minimum": 1,
"description": "Spaces for multi-line ordered list items"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
},
"ul_multi": {
"type": "integer",
"default": 1,
"minimum": 1,
"description": "Spaces for multi-line unordered list items"
},
"ol_single": {
"type": "integer",
"default": 1,
"minimum": 1,
"description": "Spaces for single-line ordered list items"
},
"ul_single": {
"type": "integer",
"default": 1,
"minimum": 1,
"description": "Spaces for single-line unordered list items"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD030/list-marker-space : Spaces after list markers : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md030.md"
},
"MD031": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
},
"list_items": {
"type": "boolean",
"default": true,
"description": "Include list items"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD031/blanks-around-fences : Fenced code blocks should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md031.md"
},
"MD032": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD032/blanks-around-lists : Lists should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md032.md"
},
"MD033": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
},
"allowed_elements": {
"type": "array",
"items": {
"type": "string"
},
"default": [],
"description": "Allowed elements"
},
"table_allowed_elements": {
"type": "array",
"items": {
"type": "string"
},
"default": [],
"description": "Allowed elements in tables"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD033/no-inline-html : Inline HTML : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md033.md"
},
"MD034": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD034/no-bare-urls : Bare URL used : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md034.md"
},
"MD035": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"style": {
"type": "string",
"default": "consistent",
"description": "Horizontal rule style"
},
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD035/hr-style : Horizontal rule style : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md035.md"
},
"MD036": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
},
"punctuation": {
"type": "string",
"default": ".,;:!?。,;:!?",
"description": "Punctuation characters"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD036/no-emphasis-as-heading : Emphasis used instead of a heading : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md036.md"
},
"MD037": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD037/no-space-in-emphasis : Spaces inside emphasis markers : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md037.md"
},
"MD038": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD038/no-space-in-code : Spaces inside code span elements : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md038.md"
},
"MD039": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD039/no-space-in-links : Spaces inside link text : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md039.md"
},
"MD040": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
},
"language_only": {
"type": "boolean",
"default": false,
"description": "Require language only"
},
"allowed_languages": {
"type": "array",
"items": {
"type": "string"
},
"default": [],
"description": "List of languages"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD040/fenced-code-language : Fenced code blocks should have a language specified : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md040.md"
},
"MD041": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"level": {
"type": "integer",
"default": 1,
"maximum": 6,
"minimum": 1,
"description": "Heading level"
},
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
},
"allow_preamble": {
"type": "boolean",
"default": false,
"description": "Allow content before first heading"
},
"front_matter_title": {
"type": "string",
"default": "^\\s*title\\s*[:=]",
"description": "RegExp for matching title in front matter"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "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.41.0/doc/md041.md"
},
"MD042": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD042/no-empty-links : No empty links : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md042.md"
},
"MD043": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"headings": {
"type": "array",
"items": {
"type": "string",
"pattern": "^(\\*|\\+|\\?|#{1,6}\\s+\\S.*)$"
},
"default": [],
"description": "List of headings"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
},
"match_case": {
"type": "boolean",
"default": false,
"description": "Match case of headings"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD043/required-headings : Required heading structure : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md043.md"
},
"MD044": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"names": {
"type": "array",
"items": {
"type": "string"
},
"default": [],
"description": "List of proper names"
},
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
},
"code_blocks": {
"type": "boolean",
"default": true,
"description": "Include code blocks"
},
"html_elements": {
"type": "boolean",
"default": true,
"description": "Include HTML elements"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD044/proper-names : Proper names should have the correct capitalization : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md044.md"
},
"MD045": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD045/no-alt-text : Images should have alternate text (alt text) : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md045.md"
},
"MD046": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"style": {
"enum": [
"consistent",
"fenced",
"indented"
],
"type": "string",
"default": "consistent",
"description": "Block style"
},
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD046/code-block-style : Code block style : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md046.md"
},
"MD047": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD047/single-trailing-newline : Files should end with a single newline character : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md047.md"
},
"MD048": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"style": {
"enum": [
"consistent",
"backtick",
"tilde"
],
"type": "string",
"default": "consistent",
"description": "Code fence style"
},
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD048/code-fence-style : Code fence style : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md048.md"
},
"MD049": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"style": {
"enum": [
"consistent",
"asterisk",
"underscore"
],
"type": "string",
"default": "consistent",
"description": "Emphasis style"
},
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD049/emphasis-style : Emphasis style : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md049.md"
},
"MD050": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"style": {
"enum": [
"consistent",
"asterisk",
"underscore"
],
"type": "string",
"default": "consistent",
"description": "Strong style"
},
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD050/strong-style : Strong style : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md050.md"
},
"MD051": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
},
"ignore_case": {
"type": "boolean",
"default": false,
"description": "Ignore case of fragments"
},
"ignored_pattern": {
"type": "string",
"default": "",
"description": "Pattern for ignoring additional fragments"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD051/link-fragments : Link fragments should be valid : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md051.md"
},
"MD052": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
},
"ignored_labels": {
"type": "array",
"items": {
"type": "string"
},
"default": [
"x"
],
"description": "Ignored link labels"
},
"shortcut_syntax": {
"type": "boolean",
"default": false,
"description": "Include shortcut syntax"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD052/reference-links-images : Reference links and images should use a label that is defined : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md052.md"
},
"MD053": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
},
"ignored_definitions": {
"type": "array",
"items": {
"type": "string"
},
"default": [
"//"
],
"description": "Ignored definitions"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD053/link-image-reference-definitions : Link and image reference definitions should be needed : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md053.md"
},
"MD054": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"full": {
"type": "boolean",
"default": true,
"description": "Allow full reference links and images"
},
"inline": {
"type": "boolean",
"default": true,
"description": "Allow inline links and images"
},
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"autolink": {
"type": "boolean",
"default": true,
"description": "Allow autolinks"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
},
"shortcut": {
"type": "boolean",
"default": true,
"description": "Allow shortcut reference links and images"
},
"collapsed": {
"type": "boolean",
"default": true,
"description": "Allow collapsed reference links and images"
},
"url_inline": {
"type": "boolean",
"default": true,
"description": "Allow URLs as inline links"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD054/link-image-style : Link and image style : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md054.md"
},
"MD055": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"style": {
"enum": [
"consistent",
"leading_only",
"trailing_only",
"leading_and_trailing",
"no_leading_or_trailing"
],
"type": "string",
"default": "consistent",
"description": "Table pipe style"
},
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD055/table-pipe-style : Table pipe style : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md055.md"
},
"MD056": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD056/table-column-count : Table column count : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md056.md"
},
"MD058": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD058/blanks-around-tables : Tables should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md058.md"
},
"MD059": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
},
"prohibited_texts": {
"type": "array",
"items": {
"type": "string"
},
"default": [
"click here",
"here",
"link",
"more"
],
"description": "Prohibited link texts"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD059/descriptive-link-text : Link text should be descriptive : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md059.md"
},
"MD060": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"style": {
"enum": [
"any",
"aligned",
"compact",
"tight"
],
"type": "string",
"default": "any",
"description": "Table column style"
},
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
},
"aligned_delimiter": {
"type": "boolean",
"default": false,
"description": "Aligned delimiter columns"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD060/table-column-style : Table column style : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md060.md"
},
"links": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
}
],
"default": true,
"description": "links : MD011, MD034, MD039, MD042, MD051, MD052, MD053, MD054, MD059"
},
"table": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
}
],
"default": true,
"description": "table : MD055, MD056, MD058, MD060"
},
"bullet": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
}
],
"default": true,
"description": "bullet : MD004, MD005, MD007, MD032"
},
"images": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
}
],
"default": true,
"description": "images : MD045, MD052, MD053, MD054"
},
"spaces": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
}
],
"default": true,
"description": "spaces : MD018, MD019, MD020, MD021, MD023"
},
"$schema": {
"type": "string",
"default": "https://raw.githubusercontent.com/DavidAnson/markdownlint/v0.41.0/schema/markdownlint-config-schema.json",
"description": "JSON Schema URI (expected by some editors)"
},
"default": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
}
],
"default": true,
"description": "Default state for all rules"
},
"extends": {
"type": [
"string",
"null"
],
"default": null,
"description": "Path to configuration file to extend"
},
"emphasis": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
}
],
"default": true,
"description": "emphasis : MD036, MD037, MD049, MD050"
},
"hard_tab": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
}
],
"default": true,
"description": "hard_tab : MD010"
},
"headings": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
}
],
"default": true,
"description": "headings : MD001, MD003, MD018, MD019, MD020, MD021, MD022, MD023, MD024, MD025, MD026, MD036, MD041, MD043"
},
"hr-style": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"style": {
"type": "string",
"default": "consistent",
"description": "Horizontal rule style"
},
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD035/hr-style : Horizontal rule style : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md035.md"
},
"language": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
}
],
"default": true,
"description": "language : MD040"
},
"spelling": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
}
],
"default": true,
"description": "spelling : MD044"
},
"ul-style": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"style": {
"enum": [
"consistent",
"asterisk",
"plus",
"dash",
"sublist"
],
"type": "string",
"default": "consistent",
"description": "List style"
},
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD004/ul-style : Unordered list style : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md004.md"
},
"ol-prefix": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"style": {
"enum": [
"one",
"ordered",
"one_or_ordered",
"zero"
],
"type": "string",
"default": "one_or_ordered",
"description": "List style"
},
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD029/ol-prefix : Ordered list item prefix : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md029.md"
},
"single-h1": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"level": {
"type": "integer",
"default": 1,
"maximum": 6,
"minimum": 1,
"description": "Heading level"
},
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
},
"front_matter_title": {
"type": "string",
"default": "^\\s*title\\s*[:=]",
"description": "RegExp for matching title in front matter"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD025/single-title/single-h1 : Multiple top-level headings in the same document : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md025.md"
},
"ul-indent": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"indent": {
"type": "integer",
"default": 2,
"minimum": 1,
"description": "Spaces for indent"
},
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
},
"start_indent": {
"type": "integer",
"default": 2,
"minimum": 1,
"description": "Spaces for first level indent (when start_indented is set)"
},
"start_indented": {
"type": "boolean",
"default": false,
"description": "Whether to indent the first level of the list"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD007/ul-indent : Unordered list indentation : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md007.md"
},
"atx_closed": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
}
],
"default": true,
"description": "atx_closed : MD020, MD021"
},
"blockquote": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
}
],
"default": true,
"description": "blockquote : MD027, MD028"
},
"whitespace": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
}
],
"default": true,
"description": "whitespace : MD009, MD010, MD012, MD027, MD028, MD030, MD037, MD038, MD039"
},
"blank_lines": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
}
],
"default": true,
"description": "blank_lines : MD012, MD022, MD031, MD032, MD047"
},
"indentation": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
}
],
"default": true,
"description": "indentation : MD005, MD007, MD027"
},
"line-length": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"stern": {
"type": "boolean",
"default": false,
"description": "Stern length checking"
},
"strict": {
"type": "boolean",
"default": false,
"description": "Strict length checking"
},
"tables": {
"type": "boolean",
"default": true,
"description": "Include tables"
},
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"headings": {
"type": "boolean",
"default": true,
"description": "Include headings"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
},
"code_blocks": {
"type": "boolean",
"default": true,
"description": "Include code blocks"
},
"line_length": {
"type": "integer",
"default": 80,
"minimum": 1,
"description": "Number of characters"
},
"heading_line_length": {
"type": "integer",
"default": 80,
"minimum": 1,
"description": "Number of characters for headings"
},
"code_block_line_length": {
"type": "integer",
"default": 80,
"minimum": 1,
"description": "Number of characters for code blocks"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD013/line-length : Line length : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md013.md"
},
"line_length": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
}
],
"default": true,
"description": "line_length : MD013"
},
"list-indent": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD005/list-indent : Inconsistent indentation for list items at the same level : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md005.md"
},
"no-alt-text": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD045/no-alt-text : Images should have alternate text (alt text) : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md045.md"
},
"no-bare-urls": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD034/no-bare-urls : Bare URL used : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md034.md"
},
"no-hard-tabs": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
},
"code_blocks": {
"type": "boolean",
"default": true,
"description": "Include code blocks"
},
"spaces_per_tab": {
"type": "integer",
"default": 1,
"minimum": 0,
"description": "Number of spaces for each hard tab"
},
"ignore_code_languages": {
"type": "array",
"items": {
"type": "string"
},
"default": [],
"description": "Fenced code languages to ignore"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD010/no-hard-tabs : Hard tabs : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md010.md"
},
"proper-names": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"names": {
"type": "array",
"items": {
"type": "string"
},
"default": [],
"description": "List of proper names"
},
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
},
"code_blocks": {
"type": "boolean",
"default": true,
"description": "Include code blocks"
},
"html_elements": {
"type": "boolean",
"default": true,
"description": "Include HTML elements"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD044/proper-names : Proper names should have the correct capitalization : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md044.md"
},
"single-title": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"level": {
"type": "integer",
"default": 1,
"maximum": 6,
"minimum": 1,
"description": "Heading level"
},
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
},
"front_matter_title": {
"type": "string",
"default": "^\\s*title\\s*[:=]",
"description": "RegExp for matching title in front matter"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD025/single-title/single-h1 : Multiple top-level headings in the same document : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md025.md"
},
"strong-style": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"style": {
"enum": [
"consistent",
"asterisk",
"underscore"
],
"type": "string",
"default": "consistent",
"description": "Strong style"
},
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD050/strong-style : Strong style : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md050.md"
},
"accessibility": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
}
],
"default": true,
"description": "accessibility : MD045, MD059"
},
"first-line-h1": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"level": {
"type": "integer",
"default": 1,
"maximum": 6,
"minimum": 1,
"description": "Heading level"
},
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
},
"allow_preamble": {
"type": "boolean",
"default": false,
"description": "Allow content before first heading"
},
"front_matter_title": {
"type": "string",
"default": "^\\s*title\\s*[:=]",
"description": "RegExp for matching title in front matter"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "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.41.0/doc/md041.md"
},
"heading-style": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"style": {
"enum": [
"consistent",
"atx",
"atx_closed",
"setext",
"setext_with_atx",
"setext_with_atx_closed"
],
"type": "string",
"default": "consistent",
"description": "Heading style"
},
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD003/heading-style : Heading style : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md003.md"
},
"emphasis-style": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"style": {
"enum": [
"consistent",
"asterisk",
"underscore"
],
"type": "string",
"default": "consistent",
"description": "Emphasis style"
},
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD049/emphasis-style : Emphasis style : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md049.md"
},
"link-fragments": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
},
"ignore_case": {
"type": "boolean",
"default": false,
"description": "Ignore case of fragments"
},
"ignored_pattern": {
"type": "string",
"default": "",
"description": "Pattern for ignoring additional fragments"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD051/link-fragments : Link fragments should be valid : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md051.md"
},
"no-empty-links": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD042/no-empty-links : No empty links : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md042.md"
},
"no-inline-html": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
},
"allowed_elements": {
"type": "array",
"items": {
"type": "string"
},
"default": [],
"description": "Allowed elements"
},
"table_allowed_elements": {
"type": "array",
"items": {
"type": "string"
},
"default": [],
"description": "Allowed elements in tables"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD033/no-inline-html : Inline HTML : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md033.md"
},
"code-block-style": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"style": {
"enum": [
"consistent",
"fenced",
"indented"
],
"type": "string",
"default": "consistent",
"description": "Block style"
},
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD046/code-block-style : Code block style : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md046.md"
},
"code-fence-style": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"style": {
"enum": [
"consistent",
"backtick",
"tilde"
],
"type": "string",
"default": "consistent",
"description": "Code fence style"
},
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD048/code-fence-style : Code fence style : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md048.md"
},
"link-image-style": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"full": {
"type": "boolean",
"default": true,
"description": "Allow full reference links and images"
},
"inline": {
"type": "boolean",
"default": true,
"description": "Allow inline links and images"
},
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"autolink": {
"type": "boolean",
"default": true,
"description": "Allow autolinks"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
},
"shortcut": {
"type": "boolean",
"default": true,
"description": "Allow shortcut reference links and images"
},
"collapsed": {
"type": "boolean",
"default": true,
"description": "Allow collapsed reference links and images"
},
"url_inline": {
"type": "boolean",
"default": true,
"description": "Allow URLs as inline links"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD054/link-image-style : Link and image style : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md054.md"
},
"no-space-in-code": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD038/no-space-in-code : Spaces inside code span elements : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md038.md"
},
"table-pipe-style": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"style": {
"enum": [
"consistent",
"leading_only",
"trailing_only",
"leading_and_trailing",
"no_leading_or_trailing"
],
"type": "string",
"default": "consistent",
"description": "Table pipe style"
},
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD055/table-pipe-style : Table pipe style : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md055.md"
},
"heading-increment": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
},
"front_matter_title": {
"type": "string",
"default": "^\\s*title\\s*[:=]",
"description": "RegExp for matching title in front matter"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD001/heading-increment : Heading levels should only increment by one level at a time : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md001.md"
},
"list-marker-space": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"ol_multi": {
"type": "integer",
"default": 1,
"minimum": 1,
"description": "Spaces for multi-line ordered list items"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
},
"ul_multi": {
"type": "integer",
"default": 1,
"minimum": 1,
"description": "Spaces for multi-line unordered list items"
},
"ol_single": {
"type": "integer",
"default": 1,
"minimum": 1,
"description": "Spaces for single-line ordered list items"
},
"ul_single": {
"type": "integer",
"default": 1,
"minimum": 1,
"description": "Spaces for single-line unordered list items"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD030/list-marker-space : Spaces after list markers : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md030.md"
},
"no-reversed-links": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD011/no-reversed-links : Reversed link syntax : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md011.md"
},
"no-space-in-links": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD039/no-space-in-links : Spaces inside link text : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md039.md"
},
"required-headings": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"headings": {
"type": "array",
"items": {
"type": "string",
"pattern": "^(\\*|\\+|\\?|#{1,6}\\s+\\S.*)$"
},
"default": [],
"description": "List of headings"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
},
"match_case": {
"type": "boolean",
"default": false,
"description": "Match case of headings"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD043/required-headings : Required heading structure : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md043.md"
},
"first-line-heading": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"level": {
"type": "integer",
"default": 1,
"maximum": 6,
"minimum": 1,
"description": "Heading level"
},
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
},
"allow_preamble": {
"type": "boolean",
"default": false,
"description": "Allow content before first heading"
},
"front_matter_title": {
"type": "string",
"default": "^\\s*title\\s*[:=]",
"description": "RegExp for matching title in front matter"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "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.41.0/doc/md041.md"
},
"heading-start-left": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD023/heading-start-left : Headings must start at the beginning of the line : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md023.md"
},
"no-multiple-blanks": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"maximum": {
"type": "integer",
"default": 1,
"minimum": 1,
"description": "Consecutive blank lines"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD012/no-multiple-blanks : Multiple consecutive blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md012.md"
},
"no-trailing-spaces": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"strict": {
"type": "boolean",
"default": false,
"description": "Include unnecessary breaks"
},
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
},
"br_spaces": {
"type": "integer",
"default": 2,
"minimum": 0,
"description": "Spaces for line break"
},
"code_blocks": {
"type": "boolean",
"default": false,
"description": "Include code blocks"
},
"list_item_empty_lines": {
"type": "boolean",
"default": false,
"description": "Allow spaces for empty lines in list items"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD009/no-trailing-spaces : Trailing spaces : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md009.md"
},
"table-column-count": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD056/table-column-count : Table column count : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md056.md"
},
"table-column-style": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"style": {
"enum": [
"any",
"aligned",
"compact",
"tight"
],
"type": "string",
"default": "any",
"description": "Table column style"
},
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
},
"aligned_delimiter": {
"type": "boolean",
"default": false,
"description": "Aligned delimiter columns"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD060/table-column-style : Table column style : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md060.md"
},
"blanks-around-lists": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD032/blanks-around-lists : Lists should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md032.md"
},
"blanks-around-fences": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
},
"list_items": {
"type": "boolean",
"default": true,
"description": "Include list items"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD031/blanks-around-fences : Fenced code blocks should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md031.md"
},
"blanks-around-tables": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD058/blanks-around-tables : Tables should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md058.md"
},
"commands-show-output": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD014/commands-show-output : Dollar signs used before commands without showing output : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md014.md"
},
"fenced-code-language": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
},
"language_only": {
"type": "boolean",
"default": false,
"description": "Require language only"
},
"allowed_languages": {
"type": "array",
"items": {
"type": "string"
},
"default": [],
"description": "List of languages"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD040/fenced-code-language : Fenced code blocks should have a language specified : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md040.md"
},
"no-blanks-blockquote": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD028/no-blanks-blockquote : Blank line inside blockquote : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md028.md"
},
"no-duplicate-heading": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
},
"siblings_only": {
"type": "boolean",
"default": false,
"description": "Only check sibling headings"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD024/no-duplicate-heading : Multiple headings with the same content : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md024.md"
},
"no-missing-space-atx": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD018/no-missing-space-atx : No space after hash on atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md018.md"
},
"no-space-in-emphasis": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD037/no-space-in-emphasis : Spaces inside emphasis markers : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md037.md"
},
"descriptive-link-text": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
},
"prohibited_texts": {
"type": "array",
"items": {
"type": "string"
},
"default": [
"click here",
"here",
"link",
"more"
],
"description": "Prohibited link texts"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD059/descriptive-link-text : Link text should be descriptive : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md059.md"
},
"no-multiple-space-atx": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD019/no-multiple-space-atx : Multiple spaces after hash on atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md019.md"
},
"blanks-around-headings": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
},
"lines_above": {
"type": [
"integer",
"array"
],
"items": {
"type": "integer"
},
"default": 1,
"minimum": -1,
"description": "Blank lines above heading"
},
"lines_below": {
"type": [
"integer",
"array"
],
"items": {
"type": "integer"
},
"default": 1,
"minimum": -1,
"description": "Blank lines below heading"
},
"include_front_matter": {
"type": "boolean",
"default": false,
"description": "Include front matter content"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD022/blanks-around-headings : Headings should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md022.md"
},
"no-emphasis-as-heading": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
},
"punctuation": {
"type": "string",
"default": ".,;:!?。,;:!?",
"description": "Punctuation characters"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD036/no-emphasis-as-heading : Emphasis used instead of a heading : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md036.md"
},
"reference-links-images": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
},
"ignored_labels": {
"type": "array",
"items": {
"type": "string"
},
"default": [
"x"
],
"description": "Ignored link labels"
},
"shortcut_syntax": {
"type": "boolean",
"default": false,
"description": "Include shortcut syntax"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD052/reference-links-images : Reference links and images should use a label that is defined : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md052.md"
},
"no-trailing-punctuation": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
},
"punctuation": {
"type": "string",
"default": ".,;:!。,;:!",
"description": "Punctuation characters"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD026/no-trailing-punctuation : Trailing punctuation in heading : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md026.md"
},
"single-trailing-newline": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD047/single-trailing-newline : Files should end with a single newline character : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md047.md"
},
"no-missing-space-closed-atx": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD020/no-missing-space-closed-atx : No space inside hashes on closed atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md020.md"
},
"no-multiple-space-blockquote": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
},
"list_items": {
"type": "boolean",
"default": true,
"description": "Include list items"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD027/no-multiple-space-blockquote : Multiple spaces after blockquote symbol : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md027.md"
},
"no-multiple-space-closed-atx": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD021/no-multiple-space-closed-atx : Multiple spaces inside hashes on closed atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md021.md"
},
"link-image-reference-definitions": {
"oneOf": [
{
"type": "boolean"
},
{
"enum": [
"error",
"warning"
]
},
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to enable the rule"
},
"severity": {
"enum": [
"error",
"warning"
],
"type": "string",
"default": "error",
"description": "Rule severity"
},
"ignored_definitions": {
"type": "array",
"items": {
"type": "string"
},
"default": [
"//"
],
"description": "Ignored definitions"
}
},
"additionalProperties": false
}
],
"default": true,
"description": "MD053/link-image-reference-definitions : Link and image reference definitions should be needed : https://github.com/DavidAnson/markdownlint/blob/v0.41.0/doc/md053.md"
}
}
}Raw JSON Schema
{
"type": "boolean",
"default": true,
"description": "Lint on open a file"
}Raw JSON Schema
{
"type": "boolean",
"default": true,
"description": "Lint on saving a file"
}Raw JSON Schema
{
"type": "boolean",
"default": true,
"description": "Lint on changing a file"
}