.markdownlint.yaml

# Refer to https://github.com/DavidAnson/markdownlint for additional rules

# Set default state for rules to false in order to handle markdownlint new rule additions
default: false

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

# MD003/header-style - Heading style
MD003:
  style: "atx"

# MD004/ul-style - Unordered list style
MD004:
  style: "dash"

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

# MD007/ul-indent - Unordered list indentation
MD007:
  indent: 2
  start_indented: false

# MD009/no-trailing-spaces - Trailing spaces
MD009:
  # Spaces for line break
  br_spaces: 2
  # Disallow spaces in empty lines in lists
  list_item_empty_lines: false
  # Report unnecessary breaks
  strict: true

# MD010/no-hard-tabs - Hard tabs
MD010:
  code_blocks: false
  spaces_per_tab: 2

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

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

# MD013/line-length - Line length
MD013: false

# MD014/commands-show-output - Dollar signs used before commands without showing output
MD014: true

# MD018/no-missing-space-atx - No space after hash on atx style heading
MD018: true

# MD019/no-multiple-space-atx - Multiple spaces after hash on atx style heading
MD019: true

# MD022/blanks-around-headers - Headings should be surrounded by blank lines
MD022:
  lines_above: 2
  lines_below: 1

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

# MD024/no-duplicate-header - Multiple headings with the same content
MD024:
  # Heading duplication allowed for non-sibling headings
  siblings_only: true

# MD025/single-title - Multiple top-level headings in the same document
MD025:
  # h1 level
  level: 1
  # Ignore front matter title param
  front_matter_title: ""

# MD026/no-trailing-punctuation - Trailing punctuation in heading
MD026:
  # Punctuation characters
  punctuation: ".,;:!。，；：！"

# MD027/no-multiple-space-blockquote - Multiple spaces after blockquote symbol
MD027: true

# MD028/no-blanks-blockquote - Blank line inside blockquote
MD028: true

# MD029/ol-prefix - Ordered list item prefix
MD029:
  # Used 1, 2, 3 style, or 1., 1., 1. style
  style: "one_or_ordered"

# 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: false

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

# MD033/no-inline-html - Inline HTML
MD033: false

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

# MD035/hr-style - Horizontal rule style
MD035:
  style: "---"

# MD036/no-emphasis-as-header - Emphasis used instead of a heading
MD036:
  # Punctuation characters
  punctuation: ".,;:!?。，；：！？"

# MD037/no-space-in-emphasis - Spaces inside emphasis markers
MD037: true

# MD038/no-space-in-code - Spaces inside code span elements
MD038: true

# MD039/no-space-in-links - Spaces inside link text
MD039: true

# MD040/fenced-code-language - Fenced code blocks should have a language specified
MD040: true

# MD041/first-line-h1 - First line in a file should be a top-level heading
MD041:
  # Heading level
  level: 1
  # RegExp for matching title in front matter
  front_matter_title: "^\\s*title\\s*[:=]"

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

# MD043/required-headers - Required heading structure
MD043: false

# MD044/proper-names - Proper names should have the correct capitalization
MD044:
  # List of proper names
  names: [
    # Companies/Organizations/Products
    "ACR",
    "AKS",
    "Amazon",
    "Anthos",
    "Auth0",
    "AWS",
    "Azure",
    "Bitbucket",
    "CIS",
    "CloudFormation",
    "CNCF",
    "DAS",
    "DDB",
    "Docker",
    "DSS",
    "DynamoDB",
    "EKS",
    "Elasticsearch",
    "Envoy",
    "GCP",
    "GitHub",
    "GKE",
    "Gmail",
    "Google",
    "HashiCorp",
    "Helm",
    "Istio",
    "JavaScript",
    "Kafka",
    "KMS",
    "Kong",
    "Kubernetes",
    "Kuma",
    "Linux",
    "macOS",
    "Microsoft",
    "MITRE",
    "NGNIX",
    "Okta",
    "OPA",
    "OpenAPI",
    "OpenShift",
    "PCI",
    "Postgres",
    "PostgreSQL",
    "MySQL",
    "RDS",
    "RHEL",
    "S3",
    "Terraform",
    "WebAssembly",
    # Terms
    "ABAC",
    "API",
    "CI/CD",
    "CLI",
    "DevOps",
    "DevSecOps",
    "DNS",
    "FAQ",
    "GDPR",
    "gRPC",
    "GUI",
    "HMAC",
    "HTML",
    "HTTP",
    "HTTPS",
    "IAM",
    "IP",
    "IRSA",
    "JSON",
    "JWT",
    "LDAP",
    "MFPA",
    "mTLS",
    "PAM",
    "RBAC",
    "REPL",
    "SaaS",
    "SASL",
    "SCIM",
    "SDK",
    "SLA",
    "SLP",
    "SMTP",
    "SSH",
    "SSL",
    "SSO",
    "TLS",
    "URL",
    "vCPU",
    "VPC",
    "vscode-opa",
    "YAML",
  ]
  # Ignore code blocks
  code_blocks: false
  html_elements: false

# MD045/no-alt-text - Images should have alternate text (alt text)
MD045: true

# MD046/code-block-style - Code block style
MD046:
  style: "fenced"

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

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

# MD049/emphasis-style - Emphasis style should be consistent
MD049:
  # Use underscore for emphasis to easily distinguish from strong/bold
  style: "underscore"

# MD050/strong-style - Strong style should be consistent
MD050:
  style: "asterisk"