| Zack Williams | ad36613 | 2018-05-14 14:45:47 -0700 | [diff] [blame^] | 1 | # markdownlint(mdl) style rules |
| 2 | # Rule descriptions: |
| 3 | # https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md |
| 4 | |
| 5 | # Copyright 2017-present Open Networking Foundation |
| 6 | # |
| 7 | # Licensed under the Apache License, Version 2.0 (the "License"); |
| 8 | # you may not use this file except in compliance with the License. |
| 9 | # You may obtain a copy of the License at |
| 10 | # |
| 11 | # http://www.apache.org/licenses/LICENSE-2.0 |
| 12 | # |
| 13 | # Unless required by applicable law or agreed to in writing, software |
| 14 | # distributed under the License is distributed on an "AS IS" BASIS, |
| 15 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 16 | # See the License for the specific language governing permissions and |
| 17 | # limitations under the License. |
| 18 | |
| 19 | # use all rules |
| 20 | all |
| 21 | |
| 22 | # Indent lists with 4 spaces |
| 23 | rule 'MD007', :indent => 4 |
| 24 | |
| 25 | # Don't enforce line length limitations within code blocks and tables |
| 26 | rule 'MD013', :code_blocks => false, :tables => false |
| 27 | |
| 28 | # Numbered lists should have the correct order |
| 29 | rule 'MD029', :style => "ordered" |
| 30 | |
| 31 | # Allow ! and ? as trailing punctuation in headers |
| 32 | rule 'MD026', :punctuation => '.,;:' |
| 33 | |