Skip to content

Commit

Permalink
Add docs to the markdownlint and yamllint config files (apache#15682)
Browse files Browse the repository at this point in the history
  • Loading branch information
jbampton authored May 6, 2021
1 parent 1024c92 commit b7b1764
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 13 deletions.
27 changes: 14 additions & 13 deletions .markdownlint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,41 +16,42 @@
# under the License.
#
---
# MD004/ul-style
# https://github.com/DavidAnson/markdownlint#rules--aliases
# MD004 ul-style - Unordered list style
MD004: false

# MD007/ul-indent
# MD007 ul-indent - Unordered list indentation
MD007: false

# MD012/no-multiple-blanks
# MD012 no-multiple-blanks - Multiple consecutive blank lines
MD012: false

# MD013 Line length
# MD013 line-length - Line length
MD013: false

# MD024/no-duplicate-heading/no-duplicate-header
# MD024 no-duplicate-heading/no-duplicate-header - Multiple headings with the same content
MD024: false

# MD026/no-trailing-punctuation
# MD026 no-trailing-punctuation - Trailing punctuation in heading
MD026: false

# MD029/ol-prefix
# MD029 ol-prefix - Ordered list item prefix
MD029: false

# MD030/list-marker-space
# MD030 list-marker-space - Spaces after list markers
MD030: false

# MD033/no-inline-html
# MD033 no-inline-html - Inline HTML
MD033: false

# MD034/no-bare-urls
# MD034 no-bare-urls - Bare URL used
MD034: false

# MD036/no-emphasis-as-heading/no-emphasis-as-header
# MD036 no-emphasis-as-heading/no-emphasis-as-header - Emphasis used instead of a heading
MD036: false

# MD040/fenced-code-language
# MD040 fenced-code-language - Fenced code blocks should have a language specified
MD040: false

# MD041/first-line-heading/first-line-h1
# MD041 first-line-heading/first-line-h1 - First line in a file should be a top-level heading
MD041: false
1 change: 1 addition & 0 deletions yamllint-config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
# specific language governing permissions and limitations
# under the License.
---
# https://yamllint.readthedocs.io/en/stable/
extends: default

rules:
Expand Down

0 comments on commit b7b1764

Please sign in to comment.