def get_details(self):
"""
Get the details for the plugin.
"""
return PluginDetails(
plugin_name="debug-only",
plugin_id="MD999",
plugin_enabled_by_default=False,
plugin_description="Debug plugin",
)
def get_details(self):
"""
Get the details for the plugin.
"""
return PluginDetails(
# code
plugin_name="code-fence-style",
plugin_id="MD048",
plugin_enabled_by_default=True,
plugin_description="Code fence style",
) # https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md048---code-fence-style
def get_details(self):
"""
Get the details for the plugin.
"""
return PluginDetails(
# headings, headers
plugin_name="first-heading-h1,first-header-h1",
plugin_id="MD002",
plugin_enabled_by_default=False,
plugin_description="First heading should be a top level heading",
) # https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md002---first-heading-should-be-a-top-level-heading
def get_details(self):
"""
Get the details for the plugin.
"""
return PluginDetails(
# whitespace, links
plugin_name="no-space-in-links",
plugin_id="MD039",
plugin_enabled_by_default=True,
plugin_description="Spaces inside link text",
) # https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md039---spaces-inside-link-text
def get_details(self):
"""
Get the details for the plugin.
"""
return PluginDetails(
# headings, headers
plugin_name="single-title,single-h1",
plugin_id="MD025",
plugin_enabled_by_default=True,
plugin_description="Multiple top level headings in the same document",
) # https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md025---multiple-top-level-headings-in-the-same-document
def get_details(self):
"""
Get the details for the plugin.
"""
return PluginDetails(
# blank_lines
plugin_name="single-trailing-newline",
plugin_id="MD047",
plugin_enabled_by_default=True,
plugin_description="Files should end with a single newline character",
) # https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md047---files-should-end-with-a-single-newline-character
def get_details(self):
"""
Get the details for the plugin.
"""
return PluginDetails(
# headings, headers
plugin_name="required-headings,required-headers",
plugin_id="MD043",
plugin_enabled_by_default=True,
plugin_description="Required heading structure",
) # https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md043---required-heading-structure
def get_details(self):
"""
Get the details for the plugin.
"""
return PluginDetails(
# bullet, ul, indentation
plugin_name="ul-start-left",
plugin_id="MD006",
plugin_enabled_by_default=False,
plugin_description="Consider starting bulleted lists at the beginning of the line",
) # https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md006---consider-starting-bulleted-lists-at-the-beginning-of-the-line
def get_details(self):
"""
Get the details for the plugin.
"""
return PluginDetails(
# links, url
plugin_name="no-bare-urls",
plugin_id="MD034",
plugin_enabled_by_default=True,
plugin_description="Bare URL used",
) # https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md034---bare-url-used
def get_details(self):
"""
Get the details for the plugin.
"""
return PluginDetails(
# code
plugin_name="code-block-style",
plugin_id="MD046",
plugin_enabled_by_default=True,
plugin_description="Code block style",
) # https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md045---images-should-have-alternate-text-alt-text
def get_details(self):
"""
Get the details for the plugin.
"""
return PluginDetails(
# bullet, ul, ol, blank_lines
plugin_name="blanks-around-lists",
plugin_id="MD032",
plugin_enabled_by_default=True,
plugin_description="Lists should be surrounded by blank lines",
) # https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md032---lists-should-be-surrounded-by-blank-lines
def get_details(self):
"""
Get the details for the plugin.
"""
return PluginDetails(
# ol, ul, whitespace
plugin_name="list-marker-space",
plugin_id="MD030",
plugin_enabled_by_default=True,
plugin_description="Spaces after list markers",
) # https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md030---spaces-after-list-markers
def get_details(self):
"""
Get the details for the plugin.
"""
return PluginDetails(
# headings, headers, spaces
plugin_name="heading-start-left, header-start-left",
plugin_id="MD023",
plugin_enabled_by_default=True,
plugin_description="Headings must start at the beginning of the line",
) # https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md023---headings-must-start-at-the-beginning-of-the-line
def get_details(self):
"""
Get the details for the plugin.
"""
return PluginDetails(
# whitespace, blank_lines
plugin_name="no-multiple-blanks",
plugin_id="MD012",
plugin_enabled_by_default=True,
plugin_description="Multiple consecutive blank lines",
) # https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md012---multiple-consecutive-blank-lines
def get_details(self):
"""
Get the details for the plugin.
"""
return PluginDetails(
# headings, headers, atx, spaces
plugin_name="no-missing-space-atx",
plugin_id="MD018",
plugin_enabled_by_default=True,
plugin_description="No space after hash on atx style heading",
) # https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md018---no-space-after-hash-on-atx-style-heading
def get_details(self):
"""
Get the details for the plugin.
"""
return PluginDetails(
# html
plugin_name="no-inline-html",
plugin_id="MD033",
plugin_enabled_by_default=True,
plugin_description="Inline HTML",
) # https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md033---inline-html
def get_details(self):
"""
Get the details for the plugin.
"""
return PluginDetails(
# headings, headers, emphasis
plugin_name="no-emphasis-as-heading,no-emphasis-as-header",
plugin_id="MD036",
plugin_enabled_by_default=True,
plugin_description="Emphasis used instead of a heading",
) # https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md036---emphasis-used-instead-of-a-heading
def get_details(self):
"""
Get the details for the plugin.
"""
return PluginDetails(
# blockquote, whitespace
plugin_name="no-blanks-blockquote",
plugin_id="MD028",
plugin_enabled_by_default=True,
plugin_description="Blank line inside blockquote",
) # https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md028---blank-line-inside-blockquote
def get_details(self):
"""
Get the details for the plugin.
"""
return PluginDetails(
# links
plugin_name="no-reversed-links",
plugin_id="MD011",
plugin_enabled_by_default=True,
plugin_description="Reversed link syntax",
) # https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md011---reversed-link-syntax
def get_details(self):
"""
Get the details for the plugin.
"""
return PluginDetails(
# links
plugin_name="no-empty-links",
plugin_id="MD042",
plugin_enabled_by_default=True,
plugin_description="No empty links",
) # https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md042---no-empty-links
def get_details(self):
"""
Get the details for the plugin.
"""
return PluginDetails(
# line_length
plugin_name="line-length",
plugin_id="MD013",
plugin_enabled_by_default=True,
plugin_description="Line length",
) # https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md013---line-length
def get_details(self):
"""
Get the details for the plugin.
"""
return PluginDetails(
# hr
plugin_name="hr-style",
plugin_id="MD035",
plugin_enabled_by_default=True,
plugin_description="Horizontal rule style",
) # https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md035---horizontal-rule-style
def get_details(self):
"""
Get the details for the plugin.
"""
return PluginDetails(
# blockquote, whitespace, indentation
plugin_name="no-multiple-space-blockquote",
plugin_id="MD027",
plugin_enabled_by_default=True,
plugin_description="Multiple spaces after blockquote symbol",
) # https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md027---multiple-spaces-after-blockquote-symbol
def get_details(self):
"""
Get the details for the plugin.
"""
return PluginDetails(
# ol
plugin_name="ol-prefix",
plugin_id="MD029",
plugin_enabled_by_default=True,
plugin_description="Ordered list item prefix",
) # https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md029---ordered-list-item-prefix
def get_details(self):
"""
Get the details for the plugin.
"""
return PluginDetails(
# bullet, ul, indentation
plugin_name="ul-indent",
plugin_id="MD007",
plugin_enabled_by_default=True,
plugin_description="Unordered list indentation",
) # https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md007---unordered-list-indentation
def get_details(self):
"""
Get the details for the plugin.
"""
return PluginDetails(
# code, language
plugin_name="fenced-code-language",
plugin_id="MD040",
plugin_enabled_by_default=True,
plugin_description="Fenced code blocks should have a language specified",
) # https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md040---fenced-code-blocks-should-have-a-language-specified
def get_details(self):
"""
Get the details for the plugin.
"""
return PluginDetails(
# whitespace
plugin_name="no-trailing-spaces",
plugin_id="MD009",
plugin_enabled_by_default=True,
plugin_description="Trailing spaces",
) # https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md007---unordered-list-indentation
def get_details(self):
"""
Get the details for the plugin.
"""
return PluginDetails(
# headings, headers, atx_closed, spaces
plugin_name="no-multiple-space-closed-atx",
plugin_id="MD021",
plugin_enabled_by_default=True,
plugin_description="Multiple spaces inside hashes on closed atx style heading",
) # https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md021---multiple-spaces-inside-hashes-on-closed-atx-style-heading
def get_details(self):
"""
Get the details for the plugin.
"""
return PluginDetails(
# whitespace, code
plugin_name="no-space-in-code",
plugin_id="MD038",
plugin_enabled_by_default=True,
plugin_description="Spaces inside code span elements",
) # https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md038---spaces-inside-code-span-elements
def get_details(self):
"""
Get the details for the plugin.
"""
return PluginDetails(
# headings, headers
plugin_name="no-duplicate-heading,no-duplicate-header",
plugin_id="MD024",
plugin_enabled_by_default=True,
plugin_description="Multiple headings with the same content",
) # https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md024---multiple-headings-with-the-same-content