.markdownlint.rb

#
# Copyright 2019 Square Inc.
#
# Licensed 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.
#

# Configuring rules:
# https://github.com/markdownlint/markdownlint/blob/master/docs/creating_styles.md
# Rule list:
# https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md

# Need to explicitly run all rules, so the per-rule configs below aren't used as an allowlist.
all

# We don't care about line length, because it prevents us from pasting in text from sane tools.
exclude_rule 'MD013'

# Enable inline HTML.
exclude_rule 'MD033'

# Allow paragraphs that consiste entirely of emphasized text.
exclude_rule 'MD036'

# Allow trailing question marks in headers.
rule 'MD026', :punctuation => '.,;:!'

# Markdownlint can't handle mkdocs' code block tab syntax, so disable code block formatting.
exclude_rule 'MD040'
exclude_rule 'MD046'

# Don't care about blank lines surround fenced code blocks.
exclude_rule 'MD031'

# Allow raw URLs.
exclude_rule 'MD034'

# Py Markdown requires four spaces to indent a sublist
rule 'MD007', :indent => 4