blob: bebc67124f8cde8dfe60ea1352e2b99fd457b12f [file] [log] [blame]
Zack Williamsad366132018-05-14 14:45:47 -07001# Copyright 2017-present Open Networking Foundation
2#
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
Zack Williamsa719e4a2018-05-16 14:44:36 -070015# markdownlint(mdl) relaxed rules file
16#
Matteo Scandolo9d96a7d2018-05-15 17:22:32 -070017# Rule descriptions:
18# https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md
Zack Williamsa719e4a2018-05-16 14:44:36 -070019# Instructions on modifying the rules file:
20# https://github.com/markdownlint/markdownlint/blob/master/docs/creating_styles.md
Matteo Scandolo9d96a7d2018-05-15 17:22:32 -070021
Zack Williamsad366132018-05-14 14:45:47 -070022# use all rules
23all
24
Zack Williamsa719e4a2018-05-16 14:44:36 -070025# Exclude rule: Header levels should only increment by one level at a time
26exclude_rule 'MD001'
27
Zack Williamsad366132018-05-14 14:45:47 -070028# Indent lists with 4 spaces
29rule 'MD007', :indent => 4
30
Matteo Scandolo9d96a7d2018-05-15 17:22:32 -070031# Exclude rule: Trailing spaces
32exclude_rule 'MD009'
33
Zack Williamsa719e4a2018-05-16 14:44:36 -070034# Don't enforce line length limitations
35exclude_rule 'MD013'
36
37# Allow ! and ? as trailing punctuation in headers
38rule 'MD026', :punctuation => '.,;:'
Matteo Scandolo9d96a7d2018-05-15 17:22:32 -070039
40# Exclude rule: Multiple spaces after blockquote symbol
41exclude_rule 'MD027'
42
Zack Williamsa719e4a2018-05-16 14:44:36 -070043# Numbered lists should have the correct order
44rule 'MD029', :style => "ordered"
45
46# Exclude rule: Fenced code blocks should be surrounded by blank lines
47exclude_rule 'MD031'
48
Luca Preted34c69c2018-05-22 17:44:42 -070049# Exclude rule: Emphasis used instead of a header
50exclude_rule 'MD036'
Matteo Scandoloc6dbfe62018-06-26 12:13:40 -070051
52# Gitbook won't care about multiple blank lines
53exclude_rule 'MD012'