Mirrors/network
1
0
Fork 0
mirror of https://github.com/linux-system-roles/network.git synced 2026-01-23 02:15:17 +00:00
Code Issues Projects Releases Wiki Activity

Add markdownlint style

Browse source 
Add a style for https://github.com/markdownlint/markdownlint/ to allow
it to be used to check for a consistent style and matching the current
style.

Signed-off-by: Till Maas <opensource@till.name>
This commit is contained in:
Till Maas 2021-04-07 11:15:12 +02:00
parent ffa98f4876
commit b55d96a8a9
3 changed files with 12 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

7
.mdl_style.rb Normal file
View file

@ -0,0 +1,7 @@
all
# https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md#md003---header-style
rule 'MD003', :style => :setext_with_atx
# https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md#md013---line-length
rule 'MD013', :line_length => 88
# https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md#md029---ordered-list-item-prefix
rule 'MD029', :style => :ordered

1
.mdlrc Normal file
View file

@ -0,0 +1 @@
style '.mdl_style.rb'

4
contributing.md
View file

@ -113,6 +113,10 @@ of this repository.
tests/test_default.yml
```
5. Check the markdown format with
[mdl](https://github.com/markdownlint/markdownlint) after changing any
markdown document.
4. Once the work is ready and commited, push the branch to your remote fork and click on
"new Pull Request" on Github.