diff options
| author | Rich Salz <rsalz@akamai.com> | 2020-05-07 13:42:14 +0200 |
|---|---|---|
| committer | Dr. Matthias St. Pierre <matthias.st.pierre@ncp-e.com> | 2020-05-08 16:22:01 +0200 |
| commit | 4ef0ddc9d8ee829bf9dceae73f7a48a55f512739 (patch) | |
| tree | e6728549dba049dde24e4dcf8e1859475255bfc1 /util/markdownlint.rb | |
| parent | c7fa92979c5964966efa298bf2a40ff451ee7482 (diff) | |
travis: enable markdownlint checks
Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org>
Reviewed-by: Matthias St. Pierre <Matthias.St.Pierre@ncp-e.com>
(Merged from https://github.com/openssl/openssl/pull/11739)
Diffstat (limited to 'util/markdownlint.rb')
| -rw-r--r-- | util/markdownlint.rb | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/util/markdownlint.rb b/util/markdownlint.rb new file mode 100644 index 0000000000..75eb21ecb8 --- /dev/null +++ b/util/markdownlint.rb @@ -0,0 +1,21 @@ +# markdownlint style rules for OpenSSL +# See https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md + +all + +# Use --- and === for H1 and H2. +rule 'MD003', :style => :setext_with_atx +# Code blocks are indented +rule 'MD046', :style => :indented + +# Bug in mdl, https://github.com/markdownlint/markdownlint/issues/313 +exclude_rule 'MD007' + +exclude_rule 'MD004' # Unordered list style TODO(fix?) +exclude_rule 'MD005' # Inconsistent indentation for list items at the same level +exclude_rule 'MD006' # Consider starting bulleted lists at the beginning of the line +exclude_rule 'MD014' # Dollar signs used before commands without showing output +exclude_rule 'MD024' # Multiple headers with the same content +exclude_rule 'MD025' # Multiple top level headers in the same document +exclude_rule 'MD029' # Ordered list item prefix +exclude_rule 'MD036' # Emphasis used instead of a header |