.rumdl.toml

# Part of the Carbon Language project, under the Apache License v2.0 with LLVM
# Exceptions. See /LICENSE for license information.
# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception

[global]
exclude = [
  ".clang-tidy",
  ".git",
  ".jj",
  "CHANGELOG.md",
  "LICENSE.md",
  ".github/pull_request_template.md",
]
respect-gitignore = true

# Disable rules that produce the most noise initially. Some of these might make
# sense to re-enable.
disable = [
  "MD033", # Inline HTML - commonly used in real-world markdown
  "MD036", # Emphasis used instead of heading
  "MD040", # Code blocks should have a language specified
  "MD014", # Commands in code blocks should show output
  "MD034", # Bare URLs
  "MD059", # Link text should be descriptive
  "MD028", # Blank line inside blockquote
]

# Line wrapping
[MD013]
reflow = true
# Note that we might want to use the "normalize" reflow mode to have more
# consistent line wrapping, however this mode is currently deeply incompatible
# with inline HTML that we use reasonably often. For now, we go with the default
# mode that doesn't try to normalize wrapping.
reflow-mode = "default"
ignore-link-urls = false
code-blocks = false
code-spans = false
atomic-spans = false
headings = false
stern = true

# Heading style
[MD003]
style = "atx"

# Narrow restriction on trailing punctuation in headings -- allows ':' and '!'.
[MD026]
punctuation = ".,;"

# Unordered list marker style
[MD004]
style = "dash"

# Ordered list numbering
[MD029]
style = "one-or-ordered"

# Unordered list indentation
[MD007]
style = "fixed"
indent = 4

[MD077]
style = "aligned"

# Spaces after list markers
[MD030]
ul-single = 3
ul-multi = 3
ol-align-column = 4

# Code block style
[MD046]
style = "fenced"

# Emphasis style
[MD049]
style = "underscore"

# Strong style
[MD050]
style = "asterisk"