github.com/yogeshkumararora/slsa-github-generator@v1.10.1-0.20240520161934-11278bd5afb4/.markdownlint.yaml (about)

     1  # Copyright 2023 SLSA Authors
     2  #
     3  # Licensed under the Apache License, Version 2.0 (the "License");
     4  # you may not use this file except in compliance with the License.
     5  # You may obtain a copy of the License at
     6  #
     7  #      http://www.apache.org/licenses/LICENSE-2.0
     8  #
     9  # Unless required by applicable law or agreed to in writing, software
    10  # distributed under the License is distributed on an "AS IS" BASIS,
    11  # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  # See the License for the specific language governing permissions and
    13  # limitations under the License.
    14  
    15  # MD004/ul-style - Unordered list style
    16  MD004:
    17    style: "dash"
    18  
    19  # MD007/ul-indent - Unordered list indentation
    20  MD007:
    21    indent: 2
    22  
    23  # MD013/line-length - Line length
    24  MD013: false
    25  
    26  # TODO(#1912): Re-enable duplicate heading checks.
    27  # MD024/no-duplicate-heading - Disable for now.
    28  MD024: false
    29  
    30  # MD025/single-title/single-h1 - Multiple top-level headings
    31  MD025:
    32    # Disable checking of YAML frontmatter.
    33    front_matter_title: ""
    34  
    35  # MD028/no-blanks-blockquote - Blank line inside blockquote
    36  MD028: false
    37  
    38  # MD029/ol-prefix - Ordered list item prefix
    39  MD029:
    40    # List style
    41    style: "ordered"
    42  
    43  # MD030/list-marker-space - Spaces after list markers
    44  MD030:
    45    # Spaces for single-line unordered list items
    46    ul_single: 1
    47    # Spaces for single-line ordered list items
    48    ol_single: 1
    49    # Spaces for multi-line unordered list items
    50    ul_multi: 1
    51    # Spaces for multi-line ordered list items
    52    ol_multi: 1
    53  
    54  # MD033/no-inline-html - Inline HTML
    55  MD033: false
    56  
    57  # MD034/no-bare-urls - Bare URL used
    58  MD034: false
    59  
    60  # MD046/code-block-style - Code block style
    61  MD046:
    62    style: "fenced"
    63  
    64  # MD047/single-trailing-newline - Files should end with a single newline character
    65  MD047: true
    66  
    67  # MD048/code-fence-style - Code fence style
    68  MD048:
    69    style: "backtick"
    70  
    71  # Disable checks that currently have bugs:
    72  MD051: false # https://github.com/DavidAnson/markdownlint/issues/538
    73  MD053: false # https://github.com/DavidAnson/markdownlint/issues/537