mirror of
https://github.com/DavidAnson/markdownlint.git
synced 2025-09-21 21:30:47 +02:00
d5abdb5a0b
Some checks are pending
Checkers / linkcheck (push) Waiting to run
Checkers / spellcheck (push) Waiting to run
CI / build (20, macos-latest) (push) Waiting to run
CI / build (20, ubuntu-latest) (push) Waiting to run
CI / build (20, windows-latest) (push) Waiting to run
CI / build (22, macos-latest) (push) Waiting to run
CI / build (22, ubuntu-latest) (push) Waiting to run
CI / build (22, windows-latest) (push) Waiting to run
CI / build (24, macos-latest) (push) Waiting to run
CI / build (24, ubuntu-latest) (push) Waiting to run
CI / build (24, windows-latest) (push) Waiting to run
CI / pnpm (push) Waiting to run
CodeQL / Analyze (push) Waiting to run
TestRepos / build (latest, ubuntu-latest) (push) Waiting to run
UpdateTestRepos / update (push) Waiting to run
2153 lines
53 KiB
TypeScript
2153 lines
53 KiB
TypeScript
/* eslint-disable */
|
|
/**
|
|
* This file was automatically generated by json-schema-to-typescript.
|
|
* DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
|
|
* and run json-schema-to-typescript to regenerate this file.
|
|
*/
|
|
|
|
export interface ConfigurationStrict {
|
|
/**
|
|
* JSON Schema URI (expected by some editors)
|
|
*/
|
|
$schema?: string;
|
|
/**
|
|
* Default state for all rules
|
|
*/
|
|
default?: boolean | ("error" | "warning");
|
|
/**
|
|
* Path to configuration file to extend
|
|
*/
|
|
extends?: string | null;
|
|
/**
|
|
* MD001/heading-increment : Heading levels should only increment by one level at a time : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md001.md
|
|
*/
|
|
MD001?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
/**
|
|
* RegExp for matching title in front matter
|
|
*/
|
|
front_matter_title?: string;
|
|
};
|
|
/**
|
|
* MD001/heading-increment : Heading levels should only increment by one level at a time : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md001.md
|
|
*/
|
|
"heading-increment"?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
/**
|
|
* RegExp for matching title in front matter
|
|
*/
|
|
front_matter_title?: string;
|
|
};
|
|
/**
|
|
* MD003/heading-style : Heading style : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md003.md
|
|
*/
|
|
MD003?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
/**
|
|
* Heading style
|
|
*/
|
|
style?: "consistent" | "atx" | "atx_closed" | "setext" | "setext_with_atx" | "setext_with_atx_closed";
|
|
};
|
|
/**
|
|
* MD003/heading-style : Heading style : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md003.md
|
|
*/
|
|
"heading-style"?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
/**
|
|
* Heading style
|
|
*/
|
|
style?: "consistent" | "atx" | "atx_closed" | "setext" | "setext_with_atx" | "setext_with_atx_closed";
|
|
};
|
|
/**
|
|
* MD004/ul-style : Unordered list style : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md004.md
|
|
*/
|
|
MD004?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
/**
|
|
* List style
|
|
*/
|
|
style?: "consistent" | "asterisk" | "plus" | "dash" | "sublist";
|
|
};
|
|
/**
|
|
* MD004/ul-style : Unordered list style : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md004.md
|
|
*/
|
|
"ul-style"?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
/**
|
|
* List style
|
|
*/
|
|
style?: "consistent" | "asterisk" | "plus" | "dash" | "sublist";
|
|
};
|
|
/**
|
|
* MD005/list-indent : Inconsistent indentation for list items at the same level : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md005.md
|
|
*/
|
|
MD005?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
};
|
|
/**
|
|
* MD005/list-indent : Inconsistent indentation for list items at the same level : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md005.md
|
|
*/
|
|
"list-indent"?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
};
|
|
/**
|
|
* MD007/ul-indent : Unordered list indentation : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md007.md
|
|
*/
|
|
MD007?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
/**
|
|
* Spaces for indent
|
|
*/
|
|
indent?: number;
|
|
/**
|
|
* Whether to indent the first level of the list
|
|
*/
|
|
start_indented?: boolean;
|
|
/**
|
|
* Spaces for first level indent (when start_indented is set)
|
|
*/
|
|
start_indent?: number;
|
|
};
|
|
/**
|
|
* MD007/ul-indent : Unordered list indentation : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md007.md
|
|
*/
|
|
"ul-indent"?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
/**
|
|
* Spaces for indent
|
|
*/
|
|
indent?: number;
|
|
/**
|
|
* Whether to indent the first level of the list
|
|
*/
|
|
start_indented?: boolean;
|
|
/**
|
|
* Spaces for first level indent (when start_indented is set)
|
|
*/
|
|
start_indent?: number;
|
|
};
|
|
/**
|
|
* MD009/no-trailing-spaces : Trailing spaces : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md009.md
|
|
*/
|
|
MD009?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
/**
|
|
* Spaces for line break
|
|
*/
|
|
br_spaces?: number;
|
|
/**
|
|
* Allow spaces for empty lines in list items
|
|
*/
|
|
list_item_empty_lines?: boolean;
|
|
/**
|
|
* Include unnecessary breaks
|
|
*/
|
|
strict?: boolean;
|
|
};
|
|
/**
|
|
* MD009/no-trailing-spaces : Trailing spaces : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md009.md
|
|
*/
|
|
"no-trailing-spaces"?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
/**
|
|
* Spaces for line break
|
|
*/
|
|
br_spaces?: number;
|
|
/**
|
|
* Allow spaces for empty lines in list items
|
|
*/
|
|
list_item_empty_lines?: boolean;
|
|
/**
|
|
* Include unnecessary breaks
|
|
*/
|
|
strict?: boolean;
|
|
};
|
|
/**
|
|
* MD010/no-hard-tabs : Hard tabs : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md010.md
|
|
*/
|
|
MD010?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
/**
|
|
* Include code blocks
|
|
*/
|
|
code_blocks?: boolean;
|
|
/**
|
|
* Fenced code languages to ignore
|
|
*/
|
|
ignore_code_languages?: string[];
|
|
/**
|
|
* Number of spaces for each hard tab
|
|
*/
|
|
spaces_per_tab?: number;
|
|
};
|
|
/**
|
|
* MD010/no-hard-tabs : Hard tabs : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md010.md
|
|
*/
|
|
"no-hard-tabs"?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
/**
|
|
* Include code blocks
|
|
*/
|
|
code_blocks?: boolean;
|
|
/**
|
|
* Fenced code languages to ignore
|
|
*/
|
|
ignore_code_languages?: string[];
|
|
/**
|
|
* Number of spaces for each hard tab
|
|
*/
|
|
spaces_per_tab?: number;
|
|
};
|
|
/**
|
|
* MD011/no-reversed-links : Reversed link syntax : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md011.md
|
|
*/
|
|
MD011?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
};
|
|
/**
|
|
* MD011/no-reversed-links : Reversed link syntax : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md011.md
|
|
*/
|
|
"no-reversed-links"?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
};
|
|
/**
|
|
* MD012/no-multiple-blanks : Multiple consecutive blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md012.md
|
|
*/
|
|
MD012?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
/**
|
|
* Consecutive blank lines
|
|
*/
|
|
maximum?: number;
|
|
};
|
|
/**
|
|
* MD012/no-multiple-blanks : Multiple consecutive blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md012.md
|
|
*/
|
|
"no-multiple-blanks"?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
/**
|
|
* Consecutive blank lines
|
|
*/
|
|
maximum?: number;
|
|
};
|
|
/**
|
|
* MD013/line-length : Line length : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md013.md
|
|
*/
|
|
MD013?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
/**
|
|
* Number of characters
|
|
*/
|
|
line_length?: number;
|
|
/**
|
|
* Number of characters for headings
|
|
*/
|
|
heading_line_length?: number;
|
|
/**
|
|
* Number of characters for code blocks
|
|
*/
|
|
code_block_line_length?: number;
|
|
/**
|
|
* Include code blocks
|
|
*/
|
|
code_blocks?: boolean;
|
|
/**
|
|
* Include tables
|
|
*/
|
|
tables?: boolean;
|
|
/**
|
|
* Include headings
|
|
*/
|
|
headings?: boolean;
|
|
/**
|
|
* Strict length checking
|
|
*/
|
|
strict?: boolean;
|
|
/**
|
|
* Stern length checking
|
|
*/
|
|
stern?: boolean;
|
|
};
|
|
/**
|
|
* MD013/line-length : Line length : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md013.md
|
|
*/
|
|
"line-length"?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
/**
|
|
* Number of characters
|
|
*/
|
|
line_length?: number;
|
|
/**
|
|
* Number of characters for headings
|
|
*/
|
|
heading_line_length?: number;
|
|
/**
|
|
* Number of characters for code blocks
|
|
*/
|
|
code_block_line_length?: number;
|
|
/**
|
|
* Include code blocks
|
|
*/
|
|
code_blocks?: boolean;
|
|
/**
|
|
* Include tables
|
|
*/
|
|
tables?: boolean;
|
|
/**
|
|
* Include headings
|
|
*/
|
|
headings?: boolean;
|
|
/**
|
|
* Strict length checking
|
|
*/
|
|
strict?: boolean;
|
|
/**
|
|
* Stern length checking
|
|
*/
|
|
stern?: boolean;
|
|
};
|
|
/**
|
|
* MD014/commands-show-output : Dollar signs used before commands without showing output : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md014.md
|
|
*/
|
|
MD014?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
};
|
|
/**
|
|
* MD014/commands-show-output : Dollar signs used before commands without showing output : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md014.md
|
|
*/
|
|
"commands-show-output"?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
};
|
|
/**
|
|
* MD018/no-missing-space-atx : No space after hash on atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md018.md
|
|
*/
|
|
MD018?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
};
|
|
/**
|
|
* MD018/no-missing-space-atx : No space after hash on atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md018.md
|
|
*/
|
|
"no-missing-space-atx"?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
};
|
|
/**
|
|
* MD019/no-multiple-space-atx : Multiple spaces after hash on atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md019.md
|
|
*/
|
|
MD019?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
};
|
|
/**
|
|
* MD019/no-multiple-space-atx : Multiple spaces after hash on atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md019.md
|
|
*/
|
|
"no-multiple-space-atx"?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
};
|
|
/**
|
|
* MD020/no-missing-space-closed-atx : No space inside hashes on closed atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md020.md
|
|
*/
|
|
MD020?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
};
|
|
/**
|
|
* MD020/no-missing-space-closed-atx : No space inside hashes on closed atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md020.md
|
|
*/
|
|
"no-missing-space-closed-atx"?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
};
|
|
/**
|
|
* MD021/no-multiple-space-closed-atx : Multiple spaces inside hashes on closed atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md021.md
|
|
*/
|
|
MD021?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
};
|
|
/**
|
|
* MD021/no-multiple-space-closed-atx : Multiple spaces inside hashes on closed atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md021.md
|
|
*/
|
|
"no-multiple-space-closed-atx"?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
};
|
|
/**
|
|
* MD022/blanks-around-headings : Headings should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md022.md
|
|
*/
|
|
MD022?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
/**
|
|
* Blank lines above heading
|
|
*/
|
|
lines_above?: number | number[];
|
|
/**
|
|
* Blank lines below heading
|
|
*/
|
|
lines_below?: number | number[];
|
|
};
|
|
/**
|
|
* MD022/blanks-around-headings : Headings should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md022.md
|
|
*/
|
|
"blanks-around-headings"?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
/**
|
|
* Blank lines above heading
|
|
*/
|
|
lines_above?: number | number[];
|
|
/**
|
|
* Blank lines below heading
|
|
*/
|
|
lines_below?: number | number[];
|
|
};
|
|
/**
|
|
* MD023/heading-start-left : Headings must start at the beginning of the line : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md023.md
|
|
*/
|
|
MD023?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
};
|
|
/**
|
|
* MD023/heading-start-left : Headings must start at the beginning of the line : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md023.md
|
|
*/
|
|
"heading-start-left"?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
};
|
|
/**
|
|
* MD024/no-duplicate-heading : Multiple headings with the same content : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md024.md
|
|
*/
|
|
MD024?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
/**
|
|
* Only check sibling headings
|
|
*/
|
|
siblings_only?: boolean;
|
|
};
|
|
/**
|
|
* MD024/no-duplicate-heading : Multiple headings with the same content : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md024.md
|
|
*/
|
|
"no-duplicate-heading"?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
/**
|
|
* Only check sibling headings
|
|
*/
|
|
siblings_only?: boolean;
|
|
};
|
|
/**
|
|
* MD025/single-title/single-h1 : Multiple top-level headings in the same document : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md025.md
|
|
*/
|
|
MD025?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
/**
|
|
* RegExp for matching title in front matter
|
|
*/
|
|
front_matter_title?: string;
|
|
/**
|
|
* Heading level
|
|
*/
|
|
level?: number;
|
|
};
|
|
/**
|
|
* MD025/single-title/single-h1 : Multiple top-level headings in the same document : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md025.md
|
|
*/
|
|
"single-title"?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
/**
|
|
* RegExp for matching title in front matter
|
|
*/
|
|
front_matter_title?: string;
|
|
/**
|
|
* Heading level
|
|
*/
|
|
level?: number;
|
|
};
|
|
/**
|
|
* MD025/single-title/single-h1 : Multiple top-level headings in the same document : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md025.md
|
|
*/
|
|
"single-h1"?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
/**
|
|
* RegExp for matching title in front matter
|
|
*/
|
|
front_matter_title?: string;
|
|
/**
|
|
* Heading level
|
|
*/
|
|
level?: number;
|
|
};
|
|
/**
|
|
* MD026/no-trailing-punctuation : Trailing punctuation in heading : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md026.md
|
|
*/
|
|
MD026?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
/**
|
|
* Punctuation characters
|
|
*/
|
|
punctuation?: string;
|
|
};
|
|
/**
|
|
* MD026/no-trailing-punctuation : Trailing punctuation in heading : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md026.md
|
|
*/
|
|
"no-trailing-punctuation"?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
/**
|
|
* Punctuation characters
|
|
*/
|
|
punctuation?: string;
|
|
};
|
|
/**
|
|
* MD027/no-multiple-space-blockquote : Multiple spaces after blockquote symbol : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md027.md
|
|
*/
|
|
MD027?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
/**
|
|
* Include list items
|
|
*/
|
|
list_items?: boolean;
|
|
};
|
|
/**
|
|
* MD027/no-multiple-space-blockquote : Multiple spaces after blockquote symbol : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md027.md
|
|
*/
|
|
"no-multiple-space-blockquote"?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
/**
|
|
* Include list items
|
|
*/
|
|
list_items?: boolean;
|
|
};
|
|
/**
|
|
* MD028/no-blanks-blockquote : Blank line inside blockquote : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md028.md
|
|
*/
|
|
MD028?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
};
|
|
/**
|
|
* MD028/no-blanks-blockquote : Blank line inside blockquote : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md028.md
|
|
*/
|
|
"no-blanks-blockquote"?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
};
|
|
/**
|
|
* MD029/ol-prefix : Ordered list item prefix : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md029.md
|
|
*/
|
|
MD029?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
/**
|
|
* List style
|
|
*/
|
|
style?: "one" | "ordered" | "one_or_ordered" | "zero";
|
|
};
|
|
/**
|
|
* MD029/ol-prefix : Ordered list item prefix : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md029.md
|
|
*/
|
|
"ol-prefix"?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
/**
|
|
* List style
|
|
*/
|
|
style?: "one" | "ordered" | "one_or_ordered" | "zero";
|
|
};
|
|
/**
|
|
* MD030/list-marker-space : Spaces after list markers : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md030.md
|
|
*/
|
|
MD030?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
/**
|
|
* Spaces for single-line unordered list items
|
|
*/
|
|
ul_single?: number;
|
|
/**
|
|
* Spaces for single-line ordered list items
|
|
*/
|
|
ol_single?: number;
|
|
/**
|
|
* Spaces for multi-line unordered list items
|
|
*/
|
|
ul_multi?: number;
|
|
/**
|
|
* Spaces for multi-line ordered list items
|
|
*/
|
|
ol_multi?: number;
|
|
};
|
|
/**
|
|
* MD030/list-marker-space : Spaces after list markers : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md030.md
|
|
*/
|
|
"list-marker-space"?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
/**
|
|
* Spaces for single-line unordered list items
|
|
*/
|
|
ul_single?: number;
|
|
/**
|
|
* Spaces for single-line ordered list items
|
|
*/
|
|
ol_single?: number;
|
|
/**
|
|
* Spaces for multi-line unordered list items
|
|
*/
|
|
ul_multi?: number;
|
|
/**
|
|
* Spaces for multi-line ordered list items
|
|
*/
|
|
ol_multi?: number;
|
|
};
|
|
/**
|
|
* MD031/blanks-around-fences : Fenced code blocks should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md031.md
|
|
*/
|
|
MD031?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
/**
|
|
* Include list items
|
|
*/
|
|
list_items?: boolean;
|
|
};
|
|
/**
|
|
* MD031/blanks-around-fences : Fenced code blocks should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md031.md
|
|
*/
|
|
"blanks-around-fences"?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
/**
|
|
* Include list items
|
|
*/
|
|
list_items?: boolean;
|
|
};
|
|
/**
|
|
* MD032/blanks-around-lists : Lists should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md032.md
|
|
*/
|
|
MD032?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
};
|
|
/**
|
|
* MD032/blanks-around-lists : Lists should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md032.md
|
|
*/
|
|
"blanks-around-lists"?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
};
|
|
/**
|
|
* MD033/no-inline-html : Inline HTML : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md033.md
|
|
*/
|
|
MD033?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
/**
|
|
* Allowed elements
|
|
*/
|
|
allowed_elements?: string[];
|
|
/**
|
|
* Allowed elements in tables
|
|
*/
|
|
table_allowed_elements?: string[];
|
|
};
|
|
/**
|
|
* MD033/no-inline-html : Inline HTML : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md033.md
|
|
*/
|
|
"no-inline-html"?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
/**
|
|
* Allowed elements
|
|
*/
|
|
allowed_elements?: string[];
|
|
/**
|
|
* Allowed elements in tables
|
|
*/
|
|
table_allowed_elements?: string[];
|
|
};
|
|
/**
|
|
* MD034/no-bare-urls : Bare URL used : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md034.md
|
|
*/
|
|
MD034?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
};
|
|
/**
|
|
* MD034/no-bare-urls : Bare URL used : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md034.md
|
|
*/
|
|
"no-bare-urls"?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
};
|
|
/**
|
|
* MD035/hr-style : Horizontal rule style : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md035.md
|
|
*/
|
|
MD035?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
/**
|
|
* Horizontal rule style
|
|
*/
|
|
style?: string;
|
|
};
|
|
/**
|
|
* MD035/hr-style : Horizontal rule style : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md035.md
|
|
*/
|
|
"hr-style"?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
/**
|
|
* Horizontal rule style
|
|
*/
|
|
style?: string;
|
|
};
|
|
/**
|
|
* MD036/no-emphasis-as-heading : Emphasis used instead of a heading : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md036.md
|
|
*/
|
|
MD036?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
/**
|
|
* Punctuation characters
|
|
*/
|
|
punctuation?: string;
|
|
};
|
|
/**
|
|
* MD036/no-emphasis-as-heading : Emphasis used instead of a heading : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md036.md
|
|
*/
|
|
"no-emphasis-as-heading"?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
/**
|
|
* Punctuation characters
|
|
*/
|
|
punctuation?: string;
|
|
};
|
|
/**
|
|
* MD037/no-space-in-emphasis : Spaces inside emphasis markers : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md037.md
|
|
*/
|
|
MD037?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
};
|
|
/**
|
|
* MD037/no-space-in-emphasis : Spaces inside emphasis markers : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md037.md
|
|
*/
|
|
"no-space-in-emphasis"?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
};
|
|
/**
|
|
* MD038/no-space-in-code : Spaces inside code span elements : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md038.md
|
|
*/
|
|
MD038?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
};
|
|
/**
|
|
* MD038/no-space-in-code : Spaces inside code span elements : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md038.md
|
|
*/
|
|
"no-space-in-code"?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
};
|
|
/**
|
|
* MD039/no-space-in-links : Spaces inside link text : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md039.md
|
|
*/
|
|
MD039?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
};
|
|
/**
|
|
* MD039/no-space-in-links : Spaces inside link text : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md039.md
|
|
*/
|
|
"no-space-in-links"?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
};
|
|
/**
|
|
* MD040/fenced-code-language : Fenced code blocks should have a language specified : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md040.md
|
|
*/
|
|
MD040?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
/**
|
|
* List of languages
|
|
*/
|
|
allowed_languages?: string[];
|
|
/**
|
|
* Require language only
|
|
*/
|
|
language_only?: boolean;
|
|
};
|
|
/**
|
|
* MD040/fenced-code-language : Fenced code blocks should have a language specified : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md040.md
|
|
*/
|
|
"fenced-code-language"?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
/**
|
|
* List of languages
|
|
*/
|
|
allowed_languages?: string[];
|
|
/**
|
|
* Require language only
|
|
*/
|
|
language_only?: boolean;
|
|
};
|
|
/**
|
|
* 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.38.0/doc/md041.md
|
|
*/
|
|
MD041?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
/**
|
|
* Allow content before first heading
|
|
*/
|
|
allow_preamble?: boolean;
|
|
/**
|
|
* RegExp for matching title in front matter
|
|
*/
|
|
front_matter_title?: string;
|
|
/**
|
|
* Heading level
|
|
*/
|
|
level?: number;
|
|
};
|
|
/**
|
|
* 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.38.0/doc/md041.md
|
|
*/
|
|
"first-line-heading"?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
/**
|
|
* Allow content before first heading
|
|
*/
|
|
allow_preamble?: boolean;
|
|
/**
|
|
* RegExp for matching title in front matter
|
|
*/
|
|
front_matter_title?: string;
|
|
/**
|
|
* Heading level
|
|
*/
|
|
level?: number;
|
|
};
|
|
/**
|
|
* 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.38.0/doc/md041.md
|
|
*/
|
|
"first-line-h1"?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
/**
|
|
* Allow content before first heading
|
|
*/
|
|
allow_preamble?: boolean;
|
|
/**
|
|
* RegExp for matching title in front matter
|
|
*/
|
|
front_matter_title?: string;
|
|
/**
|
|
* Heading level
|
|
*/
|
|
level?: number;
|
|
};
|
|
/**
|
|
* MD042/no-empty-links : No empty links : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md042.md
|
|
*/
|
|
MD042?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
};
|
|
/**
|
|
* MD042/no-empty-links : No empty links : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md042.md
|
|
*/
|
|
"no-empty-links"?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
};
|
|
/**
|
|
* MD043/required-headings : Required heading structure : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md043.md
|
|
*/
|
|
MD043?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
/**
|
|
* List of headings
|
|
*/
|
|
headings?: string[];
|
|
/**
|
|
* Match case of headings
|
|
*/
|
|
match_case?: boolean;
|
|
};
|
|
/**
|
|
* MD043/required-headings : Required heading structure : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md043.md
|
|
*/
|
|
"required-headings"?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
/**
|
|
* List of headings
|
|
*/
|
|
headings?: string[];
|
|
/**
|
|
* Match case of headings
|
|
*/
|
|
match_case?: boolean;
|
|
};
|
|
/**
|
|
* MD044/proper-names : Proper names should have the correct capitalization : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md044.md
|
|
*/
|
|
MD044?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
/**
|
|
* List of proper names
|
|
*/
|
|
names?: string[];
|
|
/**
|
|
* Include code blocks
|
|
*/
|
|
code_blocks?: boolean;
|
|
/**
|
|
* Include HTML elements
|
|
*/
|
|
html_elements?: boolean;
|
|
};
|
|
/**
|
|
* MD044/proper-names : Proper names should have the correct capitalization : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md044.md
|
|
*/
|
|
"proper-names"?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
/**
|
|
* List of proper names
|
|
*/
|
|
names?: string[];
|
|
/**
|
|
* Include code blocks
|
|
*/
|
|
code_blocks?: boolean;
|
|
/**
|
|
* Include HTML elements
|
|
*/
|
|
html_elements?: boolean;
|
|
};
|
|
/**
|
|
* MD045/no-alt-text : Images should have alternate text (alt text) : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md045.md
|
|
*/
|
|
MD045?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
};
|
|
/**
|
|
* MD045/no-alt-text : Images should have alternate text (alt text) : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md045.md
|
|
*/
|
|
"no-alt-text"?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
};
|
|
/**
|
|
* MD046/code-block-style : Code block style : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md046.md
|
|
*/
|
|
MD046?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
/**
|
|
* Block style
|
|
*/
|
|
style?: "consistent" | "fenced" | "indented";
|
|
};
|
|
/**
|
|
* MD046/code-block-style : Code block style : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md046.md
|
|
*/
|
|
"code-block-style"?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
/**
|
|
* Block style
|
|
*/
|
|
style?: "consistent" | "fenced" | "indented";
|
|
};
|
|
/**
|
|
* MD047/single-trailing-newline : Files should end with a single newline character : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md047.md
|
|
*/
|
|
MD047?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
};
|
|
/**
|
|
* MD047/single-trailing-newline : Files should end with a single newline character : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md047.md
|
|
*/
|
|
"single-trailing-newline"?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
};
|
|
/**
|
|
* MD048/code-fence-style : Code fence style : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md048.md
|
|
*/
|
|
MD048?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
/**
|
|
* Code fence style
|
|
*/
|
|
style?: "consistent" | "backtick" | "tilde";
|
|
};
|
|
/**
|
|
* MD048/code-fence-style : Code fence style : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md048.md
|
|
*/
|
|
"code-fence-style"?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
/**
|
|
* Code fence style
|
|
*/
|
|
style?: "consistent" | "backtick" | "tilde";
|
|
};
|
|
/**
|
|
* MD049/emphasis-style : Emphasis style : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md049.md
|
|
*/
|
|
MD049?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
/**
|
|
* Emphasis style
|
|
*/
|
|
style?: "consistent" | "asterisk" | "underscore";
|
|
};
|
|
/**
|
|
* MD049/emphasis-style : Emphasis style : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md049.md
|
|
*/
|
|
"emphasis-style"?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
/**
|
|
* Emphasis style
|
|
*/
|
|
style?: "consistent" | "asterisk" | "underscore";
|
|
};
|
|
/**
|
|
* MD050/strong-style : Strong style : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md050.md
|
|
*/
|
|
MD050?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
/**
|
|
* Strong style
|
|
*/
|
|
style?: "consistent" | "asterisk" | "underscore";
|
|
};
|
|
/**
|
|
* MD050/strong-style : Strong style : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md050.md
|
|
*/
|
|
"strong-style"?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
/**
|
|
* Strong style
|
|
*/
|
|
style?: "consistent" | "asterisk" | "underscore";
|
|
};
|
|
/**
|
|
* MD051/link-fragments : Link fragments should be valid : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md051.md
|
|
*/
|
|
MD051?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
/**
|
|
* Ignore case of fragments
|
|
*/
|
|
ignore_case?: boolean;
|
|
/**
|
|
* Pattern for ignoring additional fragments
|
|
*/
|
|
ignored_pattern?: string;
|
|
};
|
|
/**
|
|
* MD051/link-fragments : Link fragments should be valid : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md051.md
|
|
*/
|
|
"link-fragments"?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
/**
|
|
* Ignore case of fragments
|
|
*/
|
|
ignore_case?: boolean;
|
|
/**
|
|
* Pattern for ignoring additional fragments
|
|
*/
|
|
ignored_pattern?: string;
|
|
};
|
|
/**
|
|
* MD052/reference-links-images : Reference links and images should use a label that is defined : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md052.md
|
|
*/
|
|
MD052?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
/**
|
|
* Ignored link labels
|
|
*/
|
|
ignored_labels?: string[];
|
|
/**
|
|
* Include shortcut syntax
|
|
*/
|
|
shortcut_syntax?: boolean;
|
|
};
|
|
/**
|
|
* MD052/reference-links-images : Reference links and images should use a label that is defined : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md052.md
|
|
*/
|
|
"reference-links-images"?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
/**
|
|
* Ignored link labels
|
|
*/
|
|
ignored_labels?: string[];
|
|
/**
|
|
* Include shortcut syntax
|
|
*/
|
|
shortcut_syntax?: boolean;
|
|
};
|
|
/**
|
|
* MD053/link-image-reference-definitions : Link and image reference definitions should be needed : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md053.md
|
|
*/
|
|
MD053?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
/**
|
|
* Ignored definitions
|
|
*/
|
|
ignored_definitions?: string[];
|
|
};
|
|
/**
|
|
* MD053/link-image-reference-definitions : Link and image reference definitions should be needed : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md053.md
|
|
*/
|
|
"link-image-reference-definitions"?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
/**
|
|
* Ignored definitions
|
|
*/
|
|
ignored_definitions?: string[];
|
|
};
|
|
/**
|
|
* MD054/link-image-style : Link and image style : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md054.md
|
|
*/
|
|
MD054?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
/**
|
|
* Allow autolinks
|
|
*/
|
|
autolink?: boolean;
|
|
/**
|
|
* Allow inline links and images
|
|
*/
|
|
inline?: boolean;
|
|
/**
|
|
* Allow full reference links and images
|
|
*/
|
|
full?: boolean;
|
|
/**
|
|
* Allow collapsed reference links and images
|
|
*/
|
|
collapsed?: boolean;
|
|
/**
|
|
* Allow shortcut reference links and images
|
|
*/
|
|
shortcut?: boolean;
|
|
/**
|
|
* Allow URLs as inline links
|
|
*/
|
|
url_inline?: boolean;
|
|
};
|
|
/**
|
|
* MD054/link-image-style : Link and image style : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md054.md
|
|
*/
|
|
"link-image-style"?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
/**
|
|
* Allow autolinks
|
|
*/
|
|
autolink?: boolean;
|
|
/**
|
|
* Allow inline links and images
|
|
*/
|
|
inline?: boolean;
|
|
/**
|
|
* Allow full reference links and images
|
|
*/
|
|
full?: boolean;
|
|
/**
|
|
* Allow collapsed reference links and images
|
|
*/
|
|
collapsed?: boolean;
|
|
/**
|
|
* Allow shortcut reference links and images
|
|
*/
|
|
shortcut?: boolean;
|
|
/**
|
|
* Allow URLs as inline links
|
|
*/
|
|
url_inline?: boolean;
|
|
};
|
|
/**
|
|
* MD055/table-pipe-style : Table pipe style : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md055.md
|
|
*/
|
|
MD055?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
/**
|
|
* Table pipe style
|
|
*/
|
|
style?: "consistent" | "leading_only" | "trailing_only" | "leading_and_trailing" | "no_leading_or_trailing";
|
|
};
|
|
/**
|
|
* MD055/table-pipe-style : Table pipe style : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md055.md
|
|
*/
|
|
"table-pipe-style"?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
/**
|
|
* Table pipe style
|
|
*/
|
|
style?: "consistent" | "leading_only" | "trailing_only" | "leading_and_trailing" | "no_leading_or_trailing";
|
|
};
|
|
/**
|
|
* MD056/table-column-count : Table column count : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md056.md
|
|
*/
|
|
MD056?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
};
|
|
/**
|
|
* MD056/table-column-count : Table column count : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md056.md
|
|
*/
|
|
"table-column-count"?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
};
|
|
/**
|
|
* MD058/blanks-around-tables : Tables should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md058.md
|
|
*/
|
|
MD058?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
};
|
|
/**
|
|
* MD058/blanks-around-tables : Tables should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md058.md
|
|
*/
|
|
"blanks-around-tables"?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
};
|
|
/**
|
|
* MD059/descriptive-link-text : Link text should be descriptive : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md059.md
|
|
*/
|
|
MD059?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
/**
|
|
* Prohibited link texts
|
|
*/
|
|
prohibited_texts?: string[];
|
|
};
|
|
/**
|
|
* MD059/descriptive-link-text : Link text should be descriptive : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md059.md
|
|
*/
|
|
"descriptive-link-text"?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
/**
|
|
* Prohibited link texts
|
|
*/
|
|
prohibited_texts?: string[];
|
|
};
|
|
/**
|
|
* MD060/table-column-style : Table column style : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md060.md
|
|
*/
|
|
MD060?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
/**
|
|
* Table column style
|
|
*/
|
|
style?: "any" | "aligned" | "compact" | "tight";
|
|
};
|
|
/**
|
|
* MD060/table-column-style : Table column style : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md060.md
|
|
*/
|
|
"table-column-style"?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Rule severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
/**
|
|
* Table column style
|
|
*/
|
|
style?: "any" | "aligned" | "compact" | "tight";
|
|
};
|
|
/**
|
|
* headings : MD001, MD003, MD018, MD019, MD020, MD021, MD022, MD023, MD024, MD025, MD026, MD036, MD041, MD043
|
|
*/
|
|
headings?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Tag severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
};
|
|
/**
|
|
* bullet : MD004, MD005, MD007, MD032
|
|
*/
|
|
bullet?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Tag severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
};
|
|
/**
|
|
* ul : MD004, MD005, MD007, MD030, MD032
|
|
*/
|
|
ul?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Tag severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
};
|
|
/**
|
|
* indentation : MD005, MD007, MD027
|
|
*/
|
|
indentation?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Tag severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
};
|
|
/**
|
|
* whitespace : MD009, MD010, MD012, MD027, MD028, MD030, MD037, MD038, MD039
|
|
*/
|
|
whitespace?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Tag severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
};
|
|
/**
|
|
* hard_tab : MD010
|
|
*/
|
|
hard_tab?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Tag severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
};
|
|
/**
|
|
* links : MD011, MD034, MD039, MD042, MD051, MD052, MD053, MD054, MD059
|
|
*/
|
|
links?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Tag severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
};
|
|
/**
|
|
* blank_lines : MD012, MD022, MD031, MD032, MD047
|
|
*/
|
|
blank_lines?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Tag severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
};
|
|
/**
|
|
* line_length : MD013
|
|
*/
|
|
line_length?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Tag severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
};
|
|
/**
|
|
* code : MD014, MD031, MD038, MD040, MD046, MD048
|
|
*/
|
|
code?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Tag severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
};
|
|
/**
|
|
* atx : MD018, MD019
|
|
*/
|
|
atx?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Tag severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
};
|
|
/**
|
|
* spaces : MD018, MD019, MD020, MD021, MD023
|
|
*/
|
|
spaces?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Tag severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
};
|
|
/**
|
|
* atx_closed : MD020, MD021
|
|
*/
|
|
atx_closed?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Tag severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
};
|
|
/**
|
|
* blockquote : MD027, MD028
|
|
*/
|
|
blockquote?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Tag severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
};
|
|
/**
|
|
* ol : MD029, MD030, MD032
|
|
*/
|
|
ol?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Tag severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
};
|
|
/**
|
|
* html : MD033
|
|
*/
|
|
html?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Tag severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
};
|
|
/**
|
|
* url : MD034
|
|
*/
|
|
url?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Tag severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
};
|
|
/**
|
|
* hr : MD035
|
|
*/
|
|
hr?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Tag severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
};
|
|
/**
|
|
* emphasis : MD036, MD037, MD049, MD050
|
|
*/
|
|
emphasis?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Tag severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
};
|
|
/**
|
|
* language : MD040
|
|
*/
|
|
language?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Tag severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
};
|
|
/**
|
|
* spelling : MD044
|
|
*/
|
|
spelling?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Tag severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
};
|
|
/**
|
|
* accessibility : MD045, MD059
|
|
*/
|
|
accessibility?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Tag severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
};
|
|
/**
|
|
* images : MD045, MD052, MD053, MD054
|
|
*/
|
|
images?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Tag severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
};
|
|
/**
|
|
* table : MD055, MD056, MD058, MD060
|
|
*/
|
|
table?:
|
|
| boolean
|
|
| ("error" | "warning")
|
|
| {
|
|
/**
|
|
* Tag severity
|
|
*/
|
|
severity?: "error" | "warning" | "off";
|
|
};
|
|
}
|