util/markdownlint.rb

   1 # markdownlint style rules for OpenSSL
   2 # See https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md
   3
   4 all
   5
   6 # Use --- and === for H1 and H2.
   7 rule 'MD003', :style => :setext_with_atx
   8 # Code blocks may be fenced or indented, both are OK...
   9 # but they must be consistent throughout each file.
  10 rule 'MD046', :style => :consistent
  11
  12 # Bug in mdl, https://github.com/markdownlint/markdownlint/issues/313
  13 exclude_rule 'MD007'
  14
  15 # Not possible to line-break tables (:tables => false)
  16 # Not possible to line-break headers (currently cannot be selectively exempted)
  17 exclude_rule 'MD013'
  18
  19 exclude_rule 'MD004' # Unordered list style TODO(fix?)
  20 exclude_rule 'MD005' # Inconsistent indentation for list items at the same level
  21 exclude_rule 'MD006' # Consider starting bulleted lists at the beginning of the line
  22 exclude_rule 'MD014' # Dollar signs used before commands without showing output
  23 exclude_rule 'MD023' # Headers must start at the beginning of the line
  24 exclude_rule 'MD024' # Multiple headers with the same content
  25 exclude_rule 'MD025' # Multiple top level headers in the same document
  26 exclude_rule 'MD026' # Trailing punctuation in header
  27 exclude_rule 'MD029' # Ordered list item prefix
  28 exclude_rule 'MD030' # Spaces after list markers (default: 1!)
  29 exclude_rule 'MD033' # Allow inline HTML (complex tables are impossible without it)