Merge pull request #14 from frc6506/patch-1

Markdown improvements
frc6506 · Apr 16, 2021 · 6cca27e · 6cca27e
2 parents e852220 + 995fb43
commit 6cca27e
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/.github/workflows/config/markdownlintConfig.yml b/.github/workflows/config/markdownlintConfig.yml
@@ -72,7 +72,7 @@ MD028: false
 
 # Ordered list item prefix <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md029>
 MD029:
-  style: 'one'
+  style: 'one_or_ordered'
 
 # Spaces after list markers <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md030>
 MD030: true

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -35,7 +35,8 @@ Also checkout the VS Code extension [Markdown Preview Enhanced](https://marketpl
 
 ### Ignored Rules
 
-MD033 - Ban on Inline HTML.  Inline HTML is permitted were necessary.
+MD029 - Numbered lists may either use all 1s as number place holders or actually number the lists in order.
+MD033 - Inline HTML is currently permitted, but please avoid using it too much.
 
 ## Compress Images