.markdownlint.yml

#
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements.  See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You under the Apache License, Version 2.0
# (the "License"); you may not use this file except in compliance with
# the License.  You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# markdownlint configuration
# Reference: https://github.com/DavidAnson/markdownlint/tree/v0.32.1/doc

# MD001/heading-increment : Heading levels should only increment by one level at a time
MD001: true

# MD003/heading-style : Heading style
MD003:
  # Heading style
  style: "consistent"

# MD004/ul-style : Unordered list style
MD004:
  # List style
  style: "consistent"

# MD005/list-indent : Inconsistent indentation for list items at the same level
MD005: true

# MD007/ul-indent : Unordered list indentation
MD007:
  # Spaces for indent
  indent: 2
  # Whether to indent the first level of the list
  start_indented: false
  # Spaces for first level indent (when start_indented is set)
  start_indent: 2

# MD009/no-trailing-spaces : Trailing spaces
MD009:
  # Spaces for line break
  br_spaces: 2
  # Allow spaces for empty lines in list items
  list_item_empty_lines: false
  # Include unnecessary breaks
  strict: false

# MD010/no-hard-tabs : Hard tab
MD010:
  # Include code blocks
  code_blocks: true
  # Fenced code languages to ignore
  ignore_code_languages: []
  # Number of spaces for each hard tab
  spaces_per_tab: 1

# MD011/no-reversed-links : Reversed link syntax
MD011: true

# MD012/no-multiple-blanks : Multiple consecutive blank lines
MD012:
  # Consecutive blank lines
  maximum: 1

# MD012/line-length
MD013: false

# MD022/blanks-around-headings : Headings should be surrounded by blank lines
MD022:
  # Blank lines above heading
  lines_above: 1
  # Blank lines below heading
  lines_below: 1

# MD023/heading-start-left : Headings must start at the beginning of the line
MD023: true

# MD030/list-marker-space : Spaces after list markers
MD030:
  # Spaces for single-line unordered list items
  ul_single: 1
  # Spaces for single-line ordered list items
  ol_single: 1
  # Spaces for multi-line unordered list items
  ul_multi: 1
  # Spaces for multi-line ordered list items
  ol_multi: 1

# MD031/blanks-around-fences : Fenced code blocks should be surrounded by blank lines
MD031:
  # Include list items
  list_items: true

# MD032/blanks-around-lists : Lists should be surrounded by blank lines
MD032: true

# MD034/no-bare-urls : Bare URL used
MD034: true

# MD042/no-empty-links : No empty links
MD042: true

# MD046/code-block-style : Code block style
MD046:
  # Block style
  style: "consistent"

# MD047/single-trailing-newline : Files should end with a single newline character
MD047: true

# MD048/code-fence-style : Code fence style
MD048:
  # Code fence style
  style: "consistent"

# MD049/emphasis-style : Emphasis style
MD049:
  # Emphasis style
  style: "consistent"

# MD050/strong-style : Strong style
MD050:
  # Strong style
  style: "consistent"