@snailicide/build-config / markdownlint / markdownLintConfigJson
markdownLintConfigJson()
ts
function markdownLintConfigJson(_options): undefined | JsonObject;Defined in: packages/build-config/src/markdownlint/index.ts:25
Parameters
| Parameter | Type | Description |
|---|---|---|
_options | { [key: string]: unknown; $schema?: string; default?: boolean; extends?: null | string; MD001?: boolean; heading-increment?: boolean; MD003?: | boolean | { style?: | "consistent" | "atx" | "atx_closed" | "setext" | "setext_with_atx" | "setext_with_atx_closed"; }; heading-style?: | boolean | { style?: | "consistent" | "atx" | "atx_closed" | "setext" | "setext_with_atx" | "setext_with_atx_closed"; }; MD004?: | boolean | { style?: "consistent" | "asterisk" | "plus" | "dash" | "sublist"; }; ul-style?: | boolean | { style?: "consistent" | "asterisk" | "plus" | "dash" | "sublist"; }; MD005?: boolean; list-indent?: boolean; MD007?: | boolean | { indent?: number; start_indented?: boolean; start_indent?: number; }; ul-indent?: | boolean | { indent?: number; start_indented?: boolean; start_indent?: number; }; MD009?: | boolean | { br_spaces?: number; list_item_empty_lines?: boolean; strict?: boolean; }; no-trailing-spaces?: | boolean | { br_spaces?: number; list_item_empty_lines?: boolean; strict?: boolean; }; MD010?: | boolean | { code_blocks?: boolean; ignore_code_languages?: string[]; spaces_per_tab?: number; }; no-hard-tabs?: | boolean | { code_blocks?: boolean; ignore_code_languages?: string[]; spaces_per_tab?: number; }; MD011?: boolean; no-reversed-links?: boolean; MD012?: | boolean | { maximum?: number; }; no-multiple-blanks?: | boolean | { maximum?: number; }; MD013?: | boolean | { line_length?: number; heading_line_length?: number; code_block_line_length?: number; code_blocks?: boolean; tables?: boolean; headings?: boolean; strict?: boolean; stern?: boolean; }; line-length?: | boolean | { line_length?: number; heading_line_length?: number; code_block_line_length?: number; code_blocks?: boolean; tables?: boolean; headings?: boolean; strict?: boolean; stern?: boolean; }; MD014?: boolean; commands-show-output?: boolean; MD018?: boolean; no-missing-space-atx?: boolean; MD019?: boolean; no-multiple-space-atx?: boolean; MD020?: boolean; no-missing-space-closed-atx?: boolean; MD021?: boolean; no-multiple-space-closed-atx?: boolean; MD022?: | boolean | { lines_above?: number | number[]; lines_below?: number | number[]; }; blanks-around-headings?: | boolean | { lines_above?: number | number[]; lines_below?: number | number[]; }; MD023?: boolean; heading-start-left?: boolean; MD024?: | boolean | { siblings_only?: boolean; }; no-duplicate-heading?: | boolean | { siblings_only?: boolean; }; MD025?: | boolean | { front_matter_title?: string; level?: number; }; single-title?: | boolean | { front_matter_title?: string; level?: number; }; single-h1?: | boolean | { front_matter_title?: string; level?: number; }; MD026?: | boolean | { punctuation?: string; }; no-trailing-punctuation?: | boolean | { punctuation?: string; }; MD027?: | boolean | { list_items?: boolean; }; no-multiple-space-blockquote?: | boolean | { list_items?: boolean; }; MD028?: boolean; no-blanks-blockquote?: boolean; MD029?: | boolean | { style?: "one" | "ordered" | "one_or_ordered" | "zero"; }; ol-prefix?: | boolean | { style?: "one" | "ordered" | "one_or_ordered" | "zero"; }; MD030?: | boolean | { ul_single?: number; ol_single?: number; ul_multi?: number; ol_multi?: number; }; list-marker-space?: | boolean | { ul_single?: number; ol_single?: number; ul_multi?: number; ol_multi?: number; }; MD031?: | boolean | { list_items?: boolean; }; blanks-around-fences?: | boolean | { list_items?: boolean; }; MD032?: boolean; blanks-around-lists?: boolean; MD033?: | boolean | { allowed_elements?: string[]; }; no-inline-html?: | boolean | { allowed_elements?: string[]; }; MD034?: boolean; no-bare-urls?: boolean; MD035?: | boolean | { style?: string; }; hr-style?: | boolean | { style?: string; }; MD036?: | boolean | { punctuation?: string; }; no-emphasis-as-heading?: | boolean | { punctuation?: string; }; MD037?: boolean; no-space-in-emphasis?: boolean; MD038?: boolean; no-space-in-code?: boolean; MD039?: boolean; no-space-in-links?: boolean; MD040?: | boolean | { allowed_languages?: string[]; language_only?: boolean; }; fenced-code-language?: | boolean | { allowed_languages?: string[]; language_only?: boolean; }; MD041?: | boolean | { allow_preamble?: boolean; front_matter_title?: string; level?: number; }; first-line-heading?: | boolean | { allow_preamble?: boolean; front_matter_title?: string; level?: number; }; first-line-h1?: | boolean | { allow_preamble?: boolean; front_matter_title?: string; level?: number; }; MD042?: boolean; no-empty-links?: boolean; MD043?: | boolean | { headings?: string[]; match_case?: boolean; }; required-headings?: | boolean | { headings?: string[]; match_case?: boolean; }; MD044?: | boolean | { names?: string[]; code_blocks?: boolean; html_elements?: boolean; }; proper-names?: | boolean | { names?: string[]; code_blocks?: boolean; html_elements?: boolean; }; MD045?: boolean; no-alt-text?: boolean; MD046?: | boolean | { style?: "consistent" | "fenced" | "indented"; }; code-block-style?: | boolean | { style?: "consistent" | "fenced" | "indented"; }; MD047?: boolean; single-trailing-newline?: boolean; MD048?: | boolean | { style?: "consistent" | "backtick" | "tilde"; }; code-fence-style?: | boolean | { style?: "consistent" | "backtick" | "tilde"; }; MD049?: | boolean | { style?: "consistent" | "asterisk" | "underscore"; }; emphasis-style?: | boolean | { style?: "consistent" | "asterisk" | "underscore"; }; MD050?: | boolean | { style?: "consistent" | "asterisk" | "underscore"; }; strong-style?: | boolean | { style?: "consistent" | "asterisk" | "underscore"; }; MD051?: | boolean | { ignore_case?: boolean; ignored_pattern?: string; }; link-fragments?: | boolean | { ignore_case?: boolean; ignored_pattern?: string; }; MD052?: | boolean | { ignored_labels?: string[]; shortcut_syntax?: boolean; }; reference-links-images?: | boolean | { ignored_labels?: string[]; shortcut_syntax?: boolean; }; MD053?: | boolean | { ignored_definitions?: string[]; }; link-image-reference-definitions?: | boolean | { ignored_definitions?: string[]; }; MD054?: | boolean | { autolink?: boolean; inline?: boolean; full?: boolean; collapsed?: boolean; shortcut?: boolean; url_inline?: boolean; }; link-image-style?: | boolean | { autolink?: boolean; inline?: boolean; full?: boolean; collapsed?: boolean; shortcut?: boolean; url_inline?: boolean; }; MD055?: | boolean | { style?: | "consistent" | "leading_only" | "trailing_only" | "leading_and_trailing" | "no_leading_or_trailing"; }; table-pipe-style?: | boolean | { style?: | "consistent" | "leading_only" | "trailing_only" | "leading_and_trailing" | "no_leading_or_trailing"; }; MD056?: boolean; table-column-count?: boolean; MD058?: boolean; blanks-around-tables?: boolean; MD059?: | boolean | { prohibited_texts?: string[]; }; descriptive-link-text?: | boolean | { prohibited_texts?: string[]; }; headings?: boolean; bullet?: boolean; ul?: boolean; indentation?: boolean; whitespace?: boolean; hard_tab?: boolean; links?: boolean; blank_lines?: boolean; line_length?: boolean; code?: boolean; atx?: boolean; spaces?: boolean; atx_closed?: boolean; blockquote?: boolean; ol?: boolean; html?: boolean; url?: boolean; hr?: boolean; emphasis?: boolean; language?: boolean; spelling?: boolean; accessibility?: boolean; images?: boolean; table?: boolean; } | - |
_options.$schema? | string | JSON Schema URI (expected by some editors) |
_options.default? | boolean | Default state for all rules |
_options.extends? | null | string | Path to configuration file to extend |
_options.MD001? | boolean | 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 |
_options.heading-increment? | boolean | 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 |
_options.MD003? | | boolean | { 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 |
_options.heading-style? | | boolean | { 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 |
_options.MD004? | | boolean | { style?: "consistent" | "asterisk" | "plus" | "dash" | "sublist"; } | MD004/ul-style : Unordered list style : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md004.md |
_options.ul-style? | | boolean | { style?: "consistent" | "asterisk" | "plus" | "dash" | "sublist"; } | MD004/ul-style : Unordered list style : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md004.md |
_options.MD005? | boolean | MD005/list-indent : Inconsistent indentation for list items at the same level : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md005.md |
_options.list-indent? | boolean | MD005/list-indent : Inconsistent indentation for list items at the same level : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md005.md |
_options.MD007? | | boolean | { indent?: number; start_indented?: boolean; start_indent?: number; } | MD007/ul-indent : Unordered list indentation : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md007.md |
_options.ul-indent? | | boolean | { indent?: number; start_indented?: boolean; start_indent?: number; } | MD007/ul-indent : Unordered list indentation : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md007.md |
_options.MD009? | | boolean | { br_spaces?: number; list_item_empty_lines?: boolean; strict?: boolean; } | MD009/no-trailing-spaces : Trailing spaces : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md009.md |
_options.no-trailing-spaces? | | boolean | { br_spaces?: number; list_item_empty_lines?: boolean; strict?: boolean; } | MD009/no-trailing-spaces : Trailing spaces : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md009.md |
_options.MD010? | | boolean | { code_blocks?: boolean; ignore_code_languages?: string[]; spaces_per_tab?: number; } | MD010/no-hard-tabs : Hard tabs : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md010.md |
_options.no-hard-tabs? | | boolean | { code_blocks?: boolean; ignore_code_languages?: string[]; spaces_per_tab?: number; } | MD010/no-hard-tabs : Hard tabs : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md010.md |
_options.MD011? | boolean | MD011/no-reversed-links : Reversed link syntax : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md011.md |
_options.no-reversed-links? | boolean | MD011/no-reversed-links : Reversed link syntax : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md011.md |
_options.MD012? | | boolean | { maximum?: number; } | MD012/no-multiple-blanks : Multiple consecutive blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md012.md |
_options.no-multiple-blanks? | | boolean | { maximum?: number; } | MD012/no-multiple-blanks : Multiple consecutive blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md012.md |
_options.MD013? | | boolean | { line_length?: number; heading_line_length?: number; code_block_line_length?: number; code_blocks?: boolean; tables?: boolean; headings?: boolean; strict?: boolean; stern?: boolean; } | MD013/line-length : Line length : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md013.md |
_options.line-length? | | boolean | { line_length?: number; heading_line_length?: number; code_block_line_length?: number; code_blocks?: boolean; tables?: boolean; headings?: boolean; strict?: boolean; stern?: boolean; } | MD013/line-length : Line length : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md013.md |
_options.MD014? | 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 |
_options.commands-show-output? | 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 |
_options.MD018? | boolean | 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 |
_options.no-missing-space-atx? | boolean | 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 |
_options.MD019? | boolean | 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 |
_options.no-multiple-space-atx? | boolean | 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 |
_options.MD020? | boolean | 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 |
_options.no-missing-space-closed-atx? | boolean | 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 |
_options.MD021? | boolean | 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 |
_options.no-multiple-space-closed-atx? | boolean | 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 |
_options.MD022? | | boolean | { lines_above?: number | number[]; 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 |
_options.blanks-around-headings? | | boolean | { lines_above?: number | number[]; 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 |
_options.MD023? | boolean | 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 |
_options.heading-start-left? | boolean | 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 |
_options.MD024? | | boolean | { 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 |
_options.no-duplicate-heading? | | boolean | { 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 |
_options.MD025? | | boolean | { front_matter_title?: string; 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 |
_options.single-title? | | boolean | { front_matter_title?: string; 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 |
_options.single-h1? | | boolean | { front_matter_title?: string; 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 |
_options.MD026? | | boolean | { punctuation?: string; } | MD026/no-trailing-punctuation : Trailing punctuation in heading : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md026.md |
_options.no-trailing-punctuation? | | boolean | { punctuation?: string; } | MD026/no-trailing-punctuation : Trailing punctuation in heading : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md026.md |
_options.MD027? | | boolean | { 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 |
_options.no-multiple-space-blockquote? | | boolean | { 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 |
_options.MD028? | boolean | MD028/no-blanks-blockquote : Blank line inside blockquote : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md028.md |
_options.no-blanks-blockquote? | boolean | MD028/no-blanks-blockquote : Blank line inside blockquote : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md028.md |
_options.MD029? | | boolean | { 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 |
_options.ol-prefix? | | boolean | { 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 |
_options.MD030? | | boolean | { ul_single?: number; ol_single?: number; ul_multi?: number; ol_multi?: number; } | MD030/list-marker-space : Spaces after list markers : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md030.md |
_options.list-marker-space? | | boolean | { ul_single?: number; ol_single?: number; ul_multi?: number; ol_multi?: number; } | MD030/list-marker-space : Spaces after list markers : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md030.md |
_options.MD031? | | boolean | { 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 |
_options.blanks-around-fences? | | boolean | { 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 |
_options.MD032? | boolean | MD032/blanks-around-lists : Lists should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md032.md |
_options.blanks-around-lists? | boolean | MD032/blanks-around-lists : Lists should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md032.md |
_options.MD033? | | boolean | { allowed_elements?: string[]; } | MD033/no-inline-html : Inline HTML : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md033.md |
_options.no-inline-html? | | boolean | { allowed_elements?: string[]; } | MD033/no-inline-html : Inline HTML : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md033.md |
_options.MD034? | boolean | MD034/no-bare-urls : Bare URL used : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md034.md |
_options.no-bare-urls? | boolean | MD034/no-bare-urls : Bare URL used : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md034.md |
_options.MD035? | | boolean | { style?: string; } | MD035/hr-style : Horizontal rule style : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md035.md |
_options.hr-style? | | boolean | { style?: string; } | MD035/hr-style : Horizontal rule style : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md035.md |
_options.MD036? | | boolean | { 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 |
_options.no-emphasis-as-heading? | | boolean | { 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 |
_options.MD037? | boolean | MD037/no-space-in-emphasis : Spaces inside emphasis markers : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md037.md |
_options.no-space-in-emphasis? | boolean | MD037/no-space-in-emphasis : Spaces inside emphasis markers : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md037.md |
_options.MD038? | boolean | MD038/no-space-in-code : Spaces inside code span elements : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md038.md |
_options.no-space-in-code? | boolean | MD038/no-space-in-code : Spaces inside code span elements : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md038.md |
_options.MD039? | boolean | MD039/no-space-in-links : Spaces inside link text : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md039.md |
_options.no-space-in-links? | boolean | MD039/no-space-in-links : Spaces inside link text : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md039.md |
_options.MD040? | | boolean | { allowed_languages?: string[]; 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 |
_options.fenced-code-language? | | boolean | { allowed_languages?: string[]; 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 |
_options.MD041? | | boolean | { allow_preamble?: boolean; front_matter_title?: string; 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 |
_options.first-line-heading? | | boolean | { allow_preamble?: boolean; front_matter_title?: string; 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 |
_options.first-line-h1? | | boolean | { allow_preamble?: boolean; front_matter_title?: string; 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 |
_options.MD042? | boolean | MD042/no-empty-links : No empty links : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md042.md |
_options.no-empty-links? | boolean | MD042/no-empty-links : No empty links : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md042.md |
_options.MD043? | | boolean | { headings?: string[]; match_case?: boolean; } | MD043/required-headings : Required heading structure : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md043.md |
_options.required-headings? | | boolean | { headings?: string[]; match_case?: boolean; } | MD043/required-headings : Required heading structure : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md043.md |
_options.MD044? | | boolean | { names?: string[]; code_blocks?: boolean; 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 |
_options.proper-names? | | boolean | { names?: string[]; code_blocks?: boolean; 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 |
_options.MD045? | boolean | MD045/no-alt-text : Images should have alternate text (alt text) : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md045.md |
_options.no-alt-text? | boolean | MD045/no-alt-text : Images should have alternate text (alt text) : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md045.md |
_options.MD046? | | boolean | { style?: "consistent" | "fenced" | "indented"; } | MD046/code-block-style : Code block style : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md046.md |
_options.code-block-style? | | boolean | { style?: "consistent" | "fenced" | "indented"; } | MD046/code-block-style : Code block style : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md046.md |
_options.MD047? | boolean | MD047/single-trailing-newline : Files should end with a single newline character : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md047.md |
_options.single-trailing-newline? | boolean | MD047/single-trailing-newline : Files should end with a single newline character : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md047.md |
_options.MD048? | | boolean | { style?: "consistent" | "backtick" | "tilde"; } | MD048/code-fence-style : Code fence style : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md048.md |
_options.code-fence-style? | | boolean | { style?: "consistent" | "backtick" | "tilde"; } | MD048/code-fence-style : Code fence style : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md048.md |
_options.MD049? | | boolean | { style?: "consistent" | "asterisk" | "underscore"; } | MD049/emphasis-style : Emphasis style : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md049.md |
_options.emphasis-style? | | boolean | { style?: "consistent" | "asterisk" | "underscore"; } | MD049/emphasis-style : Emphasis style : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md049.md |
_options.MD050? | | boolean | { style?: "consistent" | "asterisk" | "underscore"; } | MD050/strong-style : Strong style : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md050.md |
_options.strong-style? | | boolean | { style?: "consistent" | "asterisk" | "underscore"; } | MD050/strong-style : Strong style : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md050.md |
_options.MD051? | | boolean | { ignore_case?: boolean; ignored_pattern?: string; } | MD051/link-fragments : Link fragments should be valid : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md051.md |
_options.link-fragments? | | boolean | { ignore_case?: boolean; ignored_pattern?: string; } | MD051/link-fragments : Link fragments should be valid : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md051.md |
_options.MD052? | | boolean | { ignored_labels?: string[]; 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 |
_options.reference-links-images? | | boolean | { ignored_labels?: string[]; 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 |
_options.MD053? | | boolean | { 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 |
_options.link-image-reference-definitions? | | boolean | { 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 |
_options.MD054? | | boolean | { autolink?: boolean; inline?: boolean; full?: boolean; collapsed?: boolean; shortcut?: boolean; url_inline?: boolean; } | MD054/link-image-style : Link and image style : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md054.md |
_options.link-image-style? | | boolean | { autolink?: boolean; inline?: boolean; full?: boolean; collapsed?: boolean; shortcut?: boolean; url_inline?: boolean; } | MD054/link-image-style : Link and image style : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md054.md |
_options.MD055? | | boolean | { 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 |
_options.table-pipe-style? | | boolean | { 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 |
_options.MD056? | boolean | MD056/table-column-count : Table column count : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md056.md |
_options.table-column-count? | boolean | MD056/table-column-count : Table column count : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md056.md |
_options.MD058? | boolean | MD058/blanks-around-tables : Tables should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md058.md |
_options.blanks-around-tables? | boolean | MD058/blanks-around-tables : Tables should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md058.md |
_options.MD059? | | boolean | { prohibited_texts?: string[]; } | MD059/descriptive-link-text : Link text should be descriptive : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md059.md |
_options.descriptive-link-text? | | boolean | { prohibited_texts?: string[]; } | MD059/descriptive-link-text : Link text should be descriptive : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md059.md |
_options.headings? | boolean | headings : MD001, MD003, MD018, MD019, MD020, MD021, MD022, MD023, MD024, MD025, MD026, MD036, MD041, MD043 |
_options.bullet? | boolean | bullet : MD004, MD005, MD007, MD032 |
_options.ul? | boolean | ul : MD004, MD005, MD007, MD030, MD032 |
_options.indentation? | boolean | indentation : MD005, MD007, MD027 |
_options.whitespace? | boolean | whitespace : MD009, MD010, MD012, MD027, MD028, MD030, MD037, MD038, MD039 |
_options.hard_tab? | boolean | hard_tab : MD010 |
_options.links? | boolean | links : MD011, MD034, MD039, MD042, MD051, MD052, MD053, MD054, MD059 |
_options.blank_lines? | boolean | blank_lines : MD012, MD022, MD031, MD032, MD047 |
_options.line_length? | boolean | line_length : MD013 |
_options.code? | boolean | code : MD014, MD031, MD038, MD040, MD046, MD048 |
_options.atx? | boolean | atx : MD018, MD019 |
_options.spaces? | boolean | spaces : MD018, MD019, MD020, MD021, MD023 |
_options.atx_closed? | boolean | atx_closed : MD020, MD021 |
_options.blockquote? | boolean | blockquote : MD027, MD028 |
_options.ol? | boolean | ol : MD029, MD030, MD032 |
_options.html? | boolean | html : MD033 |
_options.url? | boolean | url : MD034 |
_options.hr? | boolean | hr : MD035 |
_options.emphasis? | boolean | emphasis : MD036, MD037, MD049, MD050 |
_options.language? | boolean | language : MD040 |
_options.spelling? | boolean | spelling : MD044 |
_options.accessibility? | boolean | accessibility : MD045, MD059 |
_options.images? | boolean | images : MD045, MD052, MD053, MD054 |
_options.table? | boolean | table : MD055, MD056, MD058 |
Returns
undefined | JsonObject