blob: 1f7944ee7cbbe4363ccfa8e7f8881e232fe31abf [file] [log] [blame]
Joey Armstrong8388b7f2023-01-23 11:20:04 -05001# Copyright 2017-2023 Open Networking Foundation (ONF) and the ONF Contributors
Zack Williams071eda22019-05-15 18:19:51 -07002#
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# markdownlint(mdl) strict rules file
16# To use: `make LINT_STYLE=mdl_strict.rb lint`
17#
18# Rule descriptions:
19# https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md
20# Instructions on modifying the rules file:
21# https://github.com/markdownlint/markdownlint/blob/master/docs/creating_styles.md
22
23# use all rules
24all
25
26# Indent lists with 4 spaces
27rule 'MD007', :indent => 4
28
29# Don't enforce line length limitations within code blocks and tables
30rule 'MD013', :code_blocks => false, :tables => false
31
32# Allow ! and ? as trailing punctuation in headers
33rule 'MD026', :punctuation => '.,;:'
34
35# Numbered lists should have the correct order
36rule 'MD029', :style => "ordered"
37