RubyGems - mdl - Versions diffs - 0.5.0 → 0.10.0 - Mend

mdl 0.5.0 → 0.10.0

Files changed (149) hide show

checksums.yaml +4 -4
data/bin/mdl +2 -2
data/lib/mdl.rb +49 -40
data/lib/mdl/cli.rb +92 -90
data/lib/mdl/config.rb +2 -1
data/lib/mdl/doc.rb +52 -59
data/lib/mdl/kramdown_parser.rb +1 -1
data/lib/mdl/rules.rb +224 -169
data/lib/mdl/ruleset.rb +11 -10
data/lib/mdl/style.rb +30 -8
data/lib/mdl/styles/cirosantilli.rb +2 -2
data/lib/mdl/styles/default.rb +1 -1
data/lib/mdl/version.rb +1 -1
data/mdl.gemspec +23 -20
metadata +85 -289
data/.gitignore +0 -13
data/.travis.yml +0 -23
data/CHANGELOG.md +0 -187
data/README.md +0 -86
data/Rakefile +0 -8
data/docs/RULES.md +0 -1047
data/docs/configuration.md +0 -99
data/docs/creating_rules.md +0 -90
data/docs/creating_styles.md +0 -47
data/docs/rolling_a_release.md +0 -49
data/example/markdown_spec.md +0 -897
data/test/fixtures/default_mdlrc +0 -1
data/test/fixtures/dir_with_md_and_markdown/bar.markdown +0 -1
data/test/fixtures/dir_with_md_and_markdown/foo.md +0 -1
data/test/fixtures/front_matter/jekyll_post.md +0 -16
data/test/fixtures/mdlrc_disable_rules +0 -1
data/test/fixtures/mdlrc_disable_tags +0 -1
data/test/fixtures/mdlrc_enable_rules +0 -1
data/test/fixtures/mdlrc_enable_tags +0 -1
data/test/fixtures/my_ruleset.rb +0 -6
data/test/rule_tests/alternate_top_level_header.md +0 -3
data/test/rule_tests/alternate_top_level_header_style.rb +0 -4
data/test/rule_tests/atx_closed_header_spacing.md +0 -17
data/test/rule_tests/atx_header_spacing.md +0 -5
data/test/rule_tests/blockquote_blank_lines.md +0 -31
data/test/rule_tests/blockquote_spaces.md +0 -23
data/test/rule_tests/bulleted_list_2_space_indent.md +0 -6
data/test/rule_tests/bulleted_list_2_space_indent_style.rb +0 -3
data/test/rule_tests/bulleted_list_4_space_indent.md +0 -3
data/test/rule_tests/bulleted_list_not_at_beginning_of_line.md +0 -14
data/test/rule_tests/code_block_consistency.md +0 -11
data/test/rule_tests/code_block_consistency_style.rb +0 -1
data/test/rule_tests/code_block_dollar.md +0 -33
data/test/rule_tests/code_block_dollar_fence.md +0 -29
data/test/rule_tests/code_block_fenced.md +0 -17
data/test/rule_tests/code_block_fenced_style.rb +0 -1
data/test/rule_tests/code_block_indented.md +0 -17
data/test/rule_tests/code_block_indented_style.rb +0 -1
data/test/rule_tests/consecutive_blank_lines.md +0 -11
data/test/rule_tests/consistent_bullet_styles_asterisk.md +0 -3
data/test/rule_tests/consistent_bullet_styles_dash.md +0 -3
data/test/rule_tests/consistent_bullet_styles_plus.md +0 -3
data/test/rule_tests/default_test_style.rb +0 -5
data/test/rule_tests/emphasis_instead_of_headers.md +0 -40
data/test/rule_tests/empty_doc.md +0 -0
data/test/rule_tests/fenced_code_blocks.md +0 -27
data/test/rule_tests/fenced_code_with_nesting.md +0 -73
data/test/rule_tests/fenced_code_without_blank_lines.md +0 -42
data/test/rule_tests/fenced_code_without_blank_lines_style.rb +0 -3
data/test/rule_tests/first_header_bad_atx.md +0 -1
data/test/rule_tests/first_header_bad_setext.md +0 -2
data/test/rule_tests/first_header_good_atx.md +0 -1
data/test/rule_tests/first_header_good_setext.md +0 -2
data/test/rule_tests/first_line_top_level_header_atx.md +0 -3
data/test/rule_tests/first_line_top_level_header_atx_style.rb +0 -2
data/test/rule_tests/first_line_top_level_header_setext.md +0 -4
data/test/rule_tests/first_line_top_level_header_setext_style.rb +0 -2
data/test/rule_tests/fix_102_extra_nodes_in_link_text.md +0 -8
data/test/rule_tests/header_duplicate_content.md +0 -11
data/test/rule_tests/header_duplicate_content_different_nesting.md +0 -11
data/test/rule_tests/header_duplicate_content_different_nesting_style.rb +0 -1
data/test/rule_tests/header_duplicate_content_no_different_nesting.md +0 -13
data/test/rule_tests/header_multiple_toplevel.md +0 -3
data/test/rule_tests/header_mutliple_h1_no_toplevel.md +0 -5
data/test/rule_tests/header_trailing_punctuation.md +0 -11
data/test/rule_tests/header_trailing_punctuation_customized.md +0 -14
data/test/rule_tests/header_trailing_punctuation_customized_style.rb +0 -2
data/test/rule_tests/headers_bad.md +0 -7
data/test/rule_tests/headers_good.md +0 -5
data/test/rule_tests/headers_good_setext_with_atx.md +0 -7
data/test/rule_tests/headers_good_setext_with_atx_style.rb +0 -2
data/test/rule_tests/headers_good_with_issue_numbers.md +0 -12
data/test/rule_tests/headers_surrounding_space_atx.md +0 -12
data/test/rule_tests/headers_surrounding_space_setext.md +0 -15
data/test/rule_tests/headers_with_spaces_at_the_beginning.md +0 -20
data/test/rule_tests/hr_style_dashes.md +0 -22
data/test/rule_tests/hr_style_dashes_style.rb +0 -3
data/test/rule_tests/hr_style_inconsistent.md +0 -22
data/test/rule_tests/hr_style_long.md +0 -22
data/test/rule_tests/hr_style_long_style.rb +0 -3
data/test/rule_tests/hr_style_stars.md +0 -22
data/test/rule_tests/hr_style_stars_style.rb +0 -3
data/test/rule_tests/inconsistent_bullet_indent_same_level.md +0 -4
data/test/rule_tests/inconsistent_bullet_styles_asterisk.md +0 -3
data/test/rule_tests/inconsistent_bullet_styles_dash.md +0 -3
data/test/rule_tests/inconsistent_bullet_styles_plus.md +0 -3
data/test/rule_tests/incorrect_bullet_style_asterisk.md +0 -3
data/test/rule_tests/incorrect_bullet_style_asterisk_style.rb +0 -3
data/test/rule_tests/incorrect_bullet_style_dash.md +0 -3
data/test/rule_tests/incorrect_bullet_style_dash_style.rb +0 -3
data/test/rule_tests/incorrect_bullet_style_plus.md +0 -3
data/test/rule_tests/incorrect_bullet_style_plus_style.rb +0 -3
data/test/rule_tests/incorrect_header_atx.md +0 -6
data/test/rule_tests/incorrect_header_atx_closed.md +0 -6
data/test/rule_tests/incorrect_header_atx_closed_style.rb +0 -2
data/test/rule_tests/incorrect_header_atx_style.rb +0 -2
data/test/rule_tests/incorrect_header_setext.md +0 -6
data/test/rule_tests/incorrect_header_setext_style.rb +0 -2
data/test/rule_tests/inline_html.md +0 -13
data/test/rule_tests/links.md +0 -9
data/test/rule_tests/lists_without_blank_lines.md +0 -75
data/test/rule_tests/long_lines.md +0 -3
data/test/rule_tests/long_lines_100.md +0 -7
data/test/rule_tests/long_lines_100_style.rb +0 -3
data/test/rule_tests/long_lines_code.md +0 -45
data/test/rule_tests/long_lines_code_style.rb +0 -3
data/test/rule_tests/mixed_header_types_atx.md +0 -6
data/test/rule_tests/mixed_header_types_atx_closed.md +0 -6
data/test/rule_tests/mixed_header_types_setext.md +0 -6
data/test/rule_tests/no_first_line_header.md +0 -1
data/test/rule_tests/no_first_line_header_style.rb +0 -1
data/test/rule_tests/no_first_line_top_level_header.md +0 -1
data/test/rule_tests/no_first_line_top_level_header_style.rb +0 -1
data/test/rule_tests/ordered_list_item_prefix.md +0 -13
data/test/rule_tests/ordered_list_item_prefix_ordered.md +0 -13
data/test/rule_tests/ordered_list_item_prefix_ordered_style.rb +0 -3
data/test/rule_tests/reversed_link.md +0 -7
data/test/rule_tests/spaces_after_list_marker.md +0 -74
data/test/rule_tests/spaces_after_list_marker_style.rb +0 -5
data/test/rule_tests/spaces_inside_codespan_elements.md +0 -7
data/test/rule_tests/spaces_inside_emphasis_markers.md +0 -35
data/test/rule_tests/spaces_inside_link_text.md +0 -10
data/test/rule_tests/trailing_spaces_br.md +0 -4
data/test/rule_tests/trailing_spaces_br_style.rb +0 -3
data/test/rule_tests/whitespace_issues.md +0 -3
data/test/setup_tests.rb +0 -5
data/test/test_cli.rb +0 -300
data/test/test_ruledocs.rb +0 -52
data/test/test_rules.rb +0 -58
data/tools/README.md +0 -3
data/tools/docker/Dockerfile +0 -13
data/tools/docker/README.md +0 -19
data/tools/test_location.rb +0 -20
data/tools/view_markdown.rb +0 -11

data/.gitignore DELETED

@@ -1,13 +0,0 @@
-# Bundler/Ruby
-vendor/
-.bundle
-Gemfile.lock
-spec/reports
-tmp
-*.gem
-# Vim
-*.swp
-# Mac
-.DS_Store

data/.travis.yml DELETED

@@ -1,23 +0,0 @@
-sudo: false
-dist: trusty
-language: ruby
-notifications:
-  email: false
-# Temporary disable of jruby testing. There are problems on travis-ci
-# currently with this. See:
-#
-#   https://github.com/travis-ci/travis-ci/issues/9826
-#
-# before_install:
-#  - unset _JAVA_OPTIONS
-matrix:
-  include:
-    - rvm: 2.3.4
-    - rvm: 2.4.1
-    - rvm: 2.5.1
-#    - rvm: jruby-9.1.9.0
-#      env: JRUBY_OPTS="--dev"
-#    - rvm: jruby-9.2.0.0

data/CHANGELOG.md DELETED

@@ -1,187 +0,0 @@
-# Change Log
-## [Unreleased]
-### Changed
-## [v0.5.0]
-### Added
-* Add md042 to enforce code block style
-* JSON formatter/output
-### Changed
-* PR #200: allow different nesting on headers duplication check
-* MD036 - Ignore multi-line emphasized paragraphs, and emphasized paragraphs
-  that end in punctuation (#140)
-### Fixed
-* PR #168: fix issue numbers false positives
-* Fix issue #102: lint MD039 checking for nodes inside link text
-## [v0.4.0] (2016-08-22)
-### Added
-* Ignore yaml front matter option (#130, #143)
-### Changed
-* Allow top level header rules (MD002, MD025, MD041) to be configurable (#142)
-### Fixed
-* Read UTF-8 files correctly even if locale is set to C (#135, #146, #147,
-  #148)
-* Fix issues loading .mdlrc file (#126, #129, #133, #148)
-* Fix erroneous triggering of MD022/MD023 in some cases (#144)
-* Detect codeblock lines correctly when ignoring them (#141)
-## [v0.3.1] (2016-03-20)
-### Fixed
-* Fix error on starting mdl
-## [v0.3.0] (2016-03-19)
-### Rules added
-* MD041 - First line in file should be a top level header
-### Added
-* You can now load your own custom rules with the `-u` option. See
-  [rules.rb](https://github.com/markdownlint/markdownlint/blob/master/lib/mdl/rules.rb)
-  for an example of what a rules file looks like. Use the `-d` option if you
-  don't want to load markdownlint's default ruleset.
-* You can now refer to rules by human-readable/writable aliases, such as
-  'ul-style' instead of 'MD004'. See RULES.md for a list of the rule aliases.
-  You can pass the `-a` option to display rule aliases instead of MDxxx rule
-  IDs.
-### Changed
-* MD003 - An additional header style, setext_with_atx, was added to require
-  setext style headers for levels 1 and 2, but allow atx style headers for
-  levels 3 and above (i.e. header levels that can't be expressed with setext
-  style headers)
-* MD013 - You now have the option to exclude code blocks and tables from the
-  line length limit check.
-### Fixed
-* Crash with MD034 and pipe character (#93, #97)
-* MD031 failed on nested code blocks (#100, #109)
-* MD037 crashes on <li> with underscores (#83)
-* Regression introduced in v0.2.1 - ignoring rules/tags on the command line
-  caused a crash (#108)
-* MD027 false positive when line starts with a backtick (#105)
-### Merged pull requests
-* [Add support for nested code fences to MD031/MD032 - David
-  Anson](https://github.com/markdownlint/markdownlint/pull/109)
-* [Add missing word to description of MD035 in RULES.md - David
-  Anson](https://github.com/markdownlint/markdownlint/pull/86)
-* [Probe for .mdlrc in current and parent directories - Loic
-  Nageleisen](https://github.com/markdownlint/markdownlint/pull/111)
-* [MD013: allow excluding code blocks and tables - Loic
-  Nageleisen](https://github.com/markdownlint/markdownlint/pull/112)
-## [v0.2.1] (2015-04-13)
-### Fixed
-* Incorrect parsing of rules/tags specification in .mdlrc (#81)
-* Exception on image links with MD039 (#82)
-* MD037 flags on two words beginning with underscores on the same line. (#83)
-### Known issues
-* Exception on some lines with raw html list items in them (#83)
-## [v0.2.0] (2015-04-13)
-### Rules added
-* MD033 - Inline HTML
-* MD034 - Bare URL used
-* MD035 - Horizontal rule style
-* MD036 - Emphasis used instead of a header
-* MD037 - Spaces inside emphasis markers
-* MD038 - Spaces inside code span elements
-* MD039 - Spaces inside link text
-* MD040 - Fenced code blocks should have a language specified
-## Added
-* Trailing spaces rule should allow an excemption for deliberate <br/\>
-  insertion.
-* Rules can be excluded in .mdlrc and on the command line by specifying a rule
-  as ~MD000.
-### Merged pull requests
-* [Add parameter (value and default) information to rule documentation. - David Anson](https://github.com/markdownlint/markdownlint/pull/76)
-## [v0.1.0] (2015-02-22)
-### Rules added
-* MD031 - Fenced code blocks should be surrounded by blank lines
-* MD032 - Lists should be surrounded by blank lines
-### Fixed
-* MD014 triggers when it shouldn't
-### Merged pull requests
-* [MD032 - Lists should be surrounded by blank lines - David Anson](https://github.com/markdownlint/markdownlint/pull/70)
-* [MD031 - Fenced code blocks should be surrounded by blank lines - David Anson](https://github.com/markdownlint/markdownlint/pull/68)
-* [Clarify how to specify your own style - mjankowski](https://github.com/markdownlint/markdownlint/pull/65)
-* [Use single quotes to prevent early escaping - highb](https://github.com/markdownlint/markdownlint/pull/64)
-## [v0.0.1] (2014-09-07)
-### Rules added
-* MD001 - Header levels should only increment by one level at a time
-* MD002 - First header should be a h1 header
-* MD003 - Header style
-* MD004 - Unordered list style
-* MD005 - Inconsistent indentation for list items at the same level
-* MD006 - Consider starting bulleted lists at the beginning of the line
-* MD007 - Unordered list indentation
-* MD009 - Trailing spaces
-* MD010 - Hard tabs
-* MD011 - Reversed link syntax
-* MD012 - Multiple consecutive blank lines
-* MD013 - Line length
-* MD014 - Dollar signs used before commands without showing output
-* MD018 - No space after hash on atx style header
-* MD019 - Multiple spaces after hash on atx style header
-* MD020 - No space inside hashes on closed atx style header
-* MD021 - Multiple spaces inside hashes on closed atx style header
-* MD022 - Headers should be surrounded by blank lines
-* MD023 - Headers must start at the beginning of the line
-* MD024 - Multiple headers with the same content
-* MD025 - Multiple top level headers in the same document
-* MD026 - Trailing punctuation in header
-* MD027 - Multiple spaces after blockquote symbol
-* MD028 - Blank line inside blockquote
-* MD029 - Ordered list item prefix
-* MD030 - Spaces after list markers
-[Unreleased]: https://github.com/markdownlint/markdownlint/tree/master
-[v0.4.0]: https://github.com/markdownlint/markdownlint/tree/v0.4.0
-[v0.3.1]: https://github.com/markdownlint/markdownlint/tree/v0.3.1
-[v0.3.0]: https://github.com/markdownlint/markdownlint/tree/v0.3.0
-[v0.2.1]: https://github.com/markdownlint/markdownlint/tree/v0.2.1
-[v0.2.0]: https://github.com/markdownlint/markdownlint/tree/v0.2.0
-[v0.1.0]: https://github.com/markdownlint/markdownlint/tree/v0.1.0
-[v0.0.1]: https://github.com/markdownlint/markdownlint/tree/v0.0.1

data/README.md DELETED

@@ -1,86 +0,0 @@
-[![Issues on deck](https://badge.waffle.io/mivok/markdownlint.png?label=on%20deck&title=On%20Deck)](https://waffle.io/mivok/markdownlint)
-[![Travis build status](http://api.travis-ci.org/markdownlint/markdownlint.svg)](https://travis-ci.org/markdownlint/markdownlint)
-[![Gem Version](https://badge.fury.io/rb/mdl.svg)](http://badge.fury.io/rb/mdl)
-# Markdown lint tool
-A tool to check markdown files and flag style issues.
-## Installation
-Markdownlint is written in ruby and is distributed as a rubygem. As long as
-you have a relatively up to date ruby on your system, markdownlint will be
-simple to install and use. You have 2 options to install it:
-To install from rubygems, run:
-    gem install mdl
-To install the latest development version from github:
-    git clone https://github.com/markdownlint/markdownlint
-    cd markdownlint
-    rake install
-Note that you will need [rake](https://github.com/ruby/rake)
-(`gem install rake`) and [bundler](https://github.com/bundler/bundler)
-(`gem install bundler`) in order to build from source.
-## Usage
-To have markdownlint check your markdown files, simply run `mdl` with the
-filenames as a parameter:
-    mdl README.md
-Markdownlint can also take a directory, and it will scan all markdown files
-within the directory (and nested directories):
-    mdl docs/
-If you don't specify a filename, markdownlint will use stdin:
-    cat foo.md | mdl
-Markdownlint will output a list of issues it finds, and the line number where
-the issue is. See [RULES.md](docs/RULES.md) for information on each issue, as
-well as how to correct it:
-    README.md:1: MD013 Line length
-    README.md:70: MD029 Ordered list item prefix
-    README.md:71: MD029 Ordered list item prefix
-    README.md:72: MD029 Ordered list item prefix
-    README.md:73: MD029 Ordered list item prefix
-Markdownlint has many more options you can pass on the command line, run
-`mdl --help` to see what they are, or see the documentation on
-[configuring markdownlint](docs/configuration.md).
-### Styles
-Not everyone writes markdown in the same way, and there are multiple flavors
-and styles, each of which are valid. While markdownlint's default settings
-will result in markdown files that reflect the author's preferred markdown
-authoring preferences, your project may have different guidelines.
-It's not markdownlint's intention to dictate any one specific style, and in
-order to support these differing styles and/or preferences, markdownlint
-supports what are called 'style files'. A style file is a file describing
-which rules markdownlint should enable, and also what settings to apply to
-individual rules. For example, rule [MD013](docs/RULES.md#md013---line-length)
-checks for long lines, and by default will report an issue for any line longer
-than 80 characters. If your project has a different maximum line length limit,
-or if you don't want to enforce a line limit at all, then this can be
-configured in a style file.
-For more information on creating style files, see the
-[creating styles](docs/creating_styles.md) document.
-## Contributing
-1. Fork it ( <http://github.com/markdownlint/markdownlint/fork> )
-1. Create your feature branch (`git checkout -b my-new-feature`)
-1. Commit your changes (`git commit -am 'Add some feature'`)
-1. Push to the branch (`git push origin my-new-feature`)
-1. Create new Pull Request

data/Rakefile DELETED

@@ -1,8 +0,0 @@
-require 'bundler/gem_tasks'
-require 'rake/testtask'
-task :default => :test
-Rake::TestTask.new do |t|
-  t.pattern = "test/test_*.rb"
-end

data/docs/RULES.md DELETED

@@ -1,1047 +0,0 @@
-# Rules
-This document contains a description of all rules, what they are checking for,
-as well as an examples of documents that break the rule and corrected
-versions of the examples.
-## MD001 - Header levels should only increment by one level at a time
-Tags: headers
-Aliases: header-increment
-This rule is triggered when you skip header levels in a markdown document, for
-example:
-    # Header 1
-    ### Header 3
-    We skipped out a 2nd level header in this document
-When using multiple header levels, nested headers should increase by only one
-level at a time:
-    # Header 1
-    ## Header 2
-    ### Header 3
-    #### Header 4
-    ## Another Header 2
-    ### Another Header 3
-## MD002 - First header should be a top level header
-Tags: headers
-Aliases: first-header-h1
-Parameters: level (number; default 1)
-This rule is triggered when the first header in the document isn't a h1 header:
-    ## This isn't a H1 header
-    ### Another header
-The first header in the document should be a h1 header:
-    # Start with a H1 header
-    ## Then use a H2 for subsections
-## MD003 - Header style
-Tags: headers
-Aliases: header-style
-Parameters: style ("consistent", "atx", "atx_closed", "setext", "setext_with_atx"; default "consistent")
-This rule is triggered when different header styles (atx, setext, and 'closed'
-atx) are used in the same document:
-    # ATX style H1
-    ## Closed ATX style H2 ##
-    Setext style H1
-    ===============
-Be consistent with the style of header used in a document:
-    # ATX style H1
-    ## ATX style H2
-The setext_with_atx doc style allows atx-style headers of level 3 or more in
-documents with setext style headers:
-    Setext style H1
-    ===============
-    Setext style H2
-    ---------------
-    ### ATX style H3
-Note: the configured header style can be a specific style to use (atx,
-atx_closed, setext, setext_with_atx), or simply require that the usage be
-consistent within the document.
-## MD004 - Unordered list style
-Tags: bullet, ul
-Aliases: ul-style
-Parameters: style ("consistent", "asterisk", "plus", "dash"; default "consistent")
-This rule is triggered when the symbols used in the document for unordered
-list items do not match the configured unordered list style:
-    * Item 1
-    + Item 2
-    - Item 3
-To fix this issue, use the configured style for list items throughout the
-document:
-    * Item 1
-    * Item 2
-    * Item 3
-Note: the configured list style can be a specific symbol to use (asterisk,
-plus, dash), or simply require that the usage be consistent within the
-document.
-## MD005 - Inconsistent indentation for list items at the same level
-Tags: bullet, ul, indentation
-Aliases: list-indent
-This rule is triggered when list items are parsed as being at the same level,
-but don't have the same indentation:
-    * Item 1
-        * Nested Item 1
-        * Nested Item 2
-       * A misaligned item
-Usually this rule will be triggered because of a typo. Correct the indentation
-for the list to fix it:
-    * Item 1
-      * Nested Item 1
-      * Nested Item 2
-      * Nested Item 3
-## MD006 - Consider starting bulleted lists at the beginning of the line
-Tags: bullet, ul, indentation
-Aliases: ul-start-left
-This rule is triggered when top level lists don't start at the beginning of a
-line:
-    Some text
-      * List item
-      * List item
-To fix, ensure that top level list items are not indented:
-    Some test
-    * List item
-    * List item
-Rationale: Starting lists at the beginning of the line means that nested list
-items can all be indented by the same amount when an editor's indent function
-or the tab key is used to indent. Starting a list 1 space in means that the
-indent of the first nested list is less than the indent of the second level (3
-characters if you use 4 space tabs, or 1 character if you use 2 space tabs).
-## MD007 - Unordered list indentation
-Tags: bullet, ul, indentation
-Aliases: ul-indent
-Parameters: indent (number; default 2)
-This rule is triggered when list items are not indented by the configured
-number of spaces (default: 2).
-Example:
-    * List item
-       * Nested list item indented by 3 spaces
-Corrected Example:
-    * List item
-      * Nested list item indented by 2 spaces
-Rationale (2 space indent): indenting by 2 spaces allows the content of a
-nested list to be in line with the start of the content of the parent list
-when a single space is used after the list marker.
-Rationale (4 space indent): Same indent as code blocks, simpler for editors to
-implement. See
-<http://www.cirosantilli.com/markdown-styleguide/#indented-lists> for more
-information.
-In addition, this is a compatibility issue with multi-markdown parsers, which
-require a 4 space indents. See
-<http://support.markedapp.com/discussions/problems/21-sub-lists-not-indenting>
-for a description of the problem.
-## MD009 - Trailing spaces
-Tags: whitespace
-Aliases: no-trailing-spaces
-Parameters: br_spaces (number; default: 0)
-This rule is triggered on any lines that end with whitespace. To fix this,
-find the line that is triggered and remove any trailing spaces from the end.
-The br_spaces parameter allows an exception to this rule for a specific amount
-of trailing spaces used to insert an explicit line break/br element. For
-example, set br_spaces to 2 to allow exactly 2 spaces at the end of a line.
-Note: you have to set br_spaces to 2 or higher for this exception to take
-effect - you can't insert a br element with just a single trailing space, so
-if you set br_spaces to 1, the exception will be disabled, just as if it was
-set to the default of 0.
-## MD010 - Hard tabs
-Tags: whitespace, hard_tab
-Aliases: no-hard-tabs
-This rule is triggered by any lines that contain hard tab characters instead
-of using spaces for indentation. To fix this, replace any hard tab characters
-with spaces instead.
-Example:
-    Some text
-    	* hard tab character used to indent the list item
-Corrected example:
-    Some text
-        * Spaces used to indent the list item instead
-## MD011 - Reversed link syntax
-Tags: links
-Aliases: no-reversed-links
-This rule is triggered when text that appears to be a link is encountered, but
-where the syntax appears to have been reversed (the `[]` and `()` are
-reversed):
-    (Incorrect link syntax)[http://www.example.com/]
-To fix this, swap the `[]` and `()` around:
-    [Correct link syntax](http://www.example.com/)
-## MD012 - Multiple consecutive blank lines
-Tags: whitespace, blank_lines
-Aliases: no-multiple-blanks
-This rule is triggered when there are multiple consecutive blank lines in the
-document:
-    Some text here
-    Some more text here
-To fix this, delete the offending lines:
-    Some text here
-    Some more text here
-Note: this rule will not be triggered if there are multiple consecutive blank
-lines inside code blocks.
-## MD013 - Line length
-Tags: line_length
-Aliases: line-length
-Parameters: line_length, code_blocks, tables (number; default 80, boolean; default true)
-This rule is triggered when there are lines that are longer than the
-configured line length (default: 80 characters). To fix this, split the line
-up into multiple lines.
-This rule has an exception where there is no whitespace beyond the configured
-line length. This allows you to still include items such as long URLs without
-being forced to break them in the middle.
-You also have the option to exclude this rule for code blocks and tables. To
-do this, set the `code_blocks` and/or `tables` parameters to false.
-Code blocks are included in this rule by default since it is often a
-requirement for document readability, and tentatively compatible with code
-rules. Still, some languages do not lend themselves to short lines.
-## MD014 - Dollar signs used before commands without showing output
-Tags: code
-Aliases: commands-show-output
-This rule is triggered when there are code blocks showing shell commands to be
-typed, and the shell commands are preceded by dollar signs ($):
-    $ ls
-    $ cat foo
-    $ less bar
-The dollar signs are unnecessary in the above situation, and should not be
-included:
-    ls
-    cat foo
-    less bar
-However, an exception is made when there is a need to distinguish between
-typed commands and command output, as in the following example:
-    $ ls
-    foo bar
-    $ cat foo
-    Hello world
-    $ cat bar
-    baz
-Rationale: it is easier to copy and paste and less noisy if the dollar signs
-are omitted when they are not needed. See
-<http://www.cirosantilli.com/markdown-styleguide/#dollar-signs-in-shell-code>
-for more information.
-## MD018 - No space after hash on atx style header
-Tags: headers, atx, spaces
-Aliases: no-missing-space-atx
-This rule is triggered when spaces are missing after the hash characters
-in an atx style header:
-    #Header 1
-    ##Header 2
-To fix this, separate the header text from the hash character by a single
-space:
-    # Header 1
-    ## Header 2
-## MD019 - Multiple spaces after hash on atx style header
-Tags: headers, atx, spaces
-Aliases: no-multiple-space-atx
-This rule is triggered when more than one space is used to separate the
-header text from the hash characters in an atx style header:
-    #  Header 1
-    ##  Header 2
-To fix this, separate the header text from the hash character by a single
-space:
-    # Header 1
-    ## Header 2
-## MD020 - No space inside hashes on closed atx style header
-Tags: headers, atx_closed, spaces
-Aliases: no-missing-space-closed-atx
-This rule is triggered when spaces are missing inside the hash characters
-in a closed atx style header:
-    #Header 1#
-    ##Header 2##
-To fix this, separate the header text from the hash character by a single
-space:
-    # Header 1 #
-    ## Header 2 ##
-Note: this rule will fire if either side of the header is missing spaces.
-## MD021 - Multiple spaces inside hashes on closed atx style header
-Tags: headers, atx_closed, spaces
-Aliases: no-multiple-space-closed-atx
-This rule is triggered when more than one space is used to separate the
-header text from the hash characters in a closed atx style header:
-    #  Header 1  #
-    ##  Header 2  ##
-To fix this, separate the header text from the hash character by a single
-space:
-    # Header 1 #
-    ## Header 2 ##
-Note: this rule will fire if either side of the header contains multiple
-spaces.
-## MD022 - Headers should be surrounded by blank lines
-Tags: headers, blank_lines
-Aliases: blanks-around-headers
-This rule is triggered when headers (any style) are either not preceded or not
-followed by a blank line:
-    # Header 1
-    Some text
-    Some more text
-    ## Header 2
-To fix this, ensure that all headers have a blank line both before and after
-(except where the header is at the beginning or end of the document):
-    # Header 1
-    Some text
-    Some more text
-    ## Header 2
-Rationale: Aside from aesthetic reasons, some parsers, including kramdown, will
-not parse headers that don't have a blank line before, and will parse them as
-regular text.
-## MD023 - Headers must start at the beginning of the line
-Tags: headers, spaces
-Aliases: header-start-left
-This rule is triggered when a header is indented by one or more spaces:
-    Some text
-      # Indented header
-To fix this, ensure that all headers start at the beginning of the line:
-    Some text
-    # Header
-Rationale: Headers that don't start at the beginning of the line will not be
-parsed as headers, and will instead appear as regular text.
-## MD024 - Multiple headers with the same content
-Tags: headers
-Aliases: no-duplicate-header
-Parameters: allow_different_nesting (boolean; default false)
-This rule is triggered if there are multiple headers in the document that have
-the same text:
-    # Some text
-    ## Some text
-To fix this, ensure that the content of each header is different:
-    # Some text
-    ## Some more text
-Rationale: Some markdown parses generate anchors for headers based on the
-header name, and having headers with the same content can cause problems with
-this.
-If the parameter `allow_different_nesting` is set to `true`, header duplication
-under different nesting is allowed, like it usually happens in change logs:
-    # Change log
-    ## 2.0.0
-    ### Bug fixes
-    ### Features
-    ## 1.0.0
-    ### Bug fixes
-## MD025 - Multiple top level headers in the same document
-Tags: headers
-Aliases: single-h1
-Parameters: level (number; default 1)
-This rule is triggered when a top level header is in use (the first line of
-the file is a h1 header), and more than one h1 header is in use in the
-document:
-    # Top level header
-    # Another top level header
-To fix, structure your document so that there is a single h1 header that is
-the title for the document, and all later headers are h2 or lower level
-headers:
-    # Title
-    ## Header
-    ## Another header
-Rationale: A top level header is a h1 on the first line of the file, and
-serves as the title for the document. If this convention is in use, then there
-can not be more than one title for the document, and the entire document
-should be contained within this header.
-Note: The `level` parameter can be used to change the top level (ex: to h2) in
-cases where an h1 is added externally.
-## MD026 - Trailing punctuation in header
-Tags: headers
-Aliases: no-trailing-punctuation
-Parameters: punctuation (string; default ".,;:!?")
-This rule is triggered on any header that has a punctuation character as the
-last character in the line:
-    # This is a header.
-To fix this, remove any trailing punctuation:
-    # This is a header
-Note: The punctuation parameter can be used to specify what characters class
-as punctuation at the end of the header. For example, you can set it to
-`'.,;:!'` to allow headers with question marks in them, such as might be used
-in an FAQ.
-## MD027 - Multiple spaces after blockquote symbol
-Tags: blockquote, whitespace, indentation
-Aliases: no-multiple-space-blockquote
-This rule is triggered when blockquotes have more than one space after the
-blockquote (`>`) symbol:
-    >  This is a block quote with bad indentation
-    >  there should only be one.
-To fix, remove any extraneous space:
-    > This is a blockquote with correct
-    > indentation.
-## MD028 - Blank line inside blockquote
-Tags: blockquote, whitespace
-Aliases: no-blanks-blockquote
-This rule is triggered when two blockquote blocks are separated by nothing
-except for a blank line:
-    > This is a blockquote
-    > which is immediately followed by
-    > this blockquote. Unfortunately
-    > In some parsers, these are treated as the same blockquote.
-To fix this, ensure that any blockquotes that are right next to each other
-have some text in between:
-    > This is a blockquote.
-    And Jimmy also said:
-    > This too is a blockquote.
-Alternatively, if they are supposed to be the same quote, then add the
-blockquote symbol at the beginning of the blank line:
-    > This is a blockquote.
-    >
-    > This is the same blockquote.
-Rationale: Some markdown parsers will treat two blockquotes separated by one
-or more blank lines as the same blockquote, while others will treat them as
-separate blockquotes.
-## MD029 - Ordered list item prefix
-Tags: ol
-Aliases: ol-prefix
-Parameters: style ("one", "ordered"; default "one")
-This rule is triggered on ordered lists that do not either start with '1.' or
-do not have a prefix that increases in numerical order (depending on the
-configured style, which defaults to 'one').
-Example valid list if the style is configured as 'one':
-    1. Do this.
-    1. Do that.
-    1. Done.
-Example valid list if the style is configured as 'ordered':
-    1. Do this.
-    2. Do that.
-    3. Done.
-## MD030 - Spaces after list markers
-Tags: ol, ul, whitespace
-Aliases: list-marker-space
-Parameters: ul_single, ol_single, ul_multi, ol_multi (number, default 1)
-This rule checks for the number of spaces between a list marker (e.g. '`-`',
-'`*`', '`+`' or '`1.`') and the text of the list item.
-The number of spaces checked for depends on the document style in use, but the
-default is 1 space after any list marker:
-    * Foo
-    * Bar
-    * Baz
-    1. Foo
-    1. Bar
-    1. Baz
-    1. Foo
-       * Bar
-    1. Baz
-A document style may change the number of spaces after unordered list items
-and ordered list items independently, as well as based on whether the content
-of every item in the list consists of a single paragraph, or multiple
-paragraphs (including sub-lists and code blocks).
-For example, the style guide at
-<http://www.cirosantilli.com/markdown-styleguide/#spaces-after-marker>
-specifies that 1 space after the list marker should be used if every item in
-the list fits within a single paragraph, but to use 2 or 3 spaces (for ordered
-and unordered lists respectively) if there are multiple paragraphs of content
-inside the list:
-    * Foo
-    * Bar
-    * Baz
-    vs.
-    *   Foo
-        Second paragraph
-    *   Bar
-    or
-    1.  Foo
-        Second paragraph
-    1.  Bar
-To fix this, ensure the correct number of spaces are used after list marker
-for your selected document style.
-## MD031 - Fenced code blocks should be surrounded by blank lines
-Tags: code, blank_lines
-Aliases: blanks-around-fences
-This rule is triggered when fenced code blocks are either not preceded or not
-followed by a blank line:
-    Some text
-    ```
-    Code block
-    ```
-    ```
-    Another code block
-    ```
-    Some more text
-To fix this, ensure that all fenced code blocks have a blank line both before
-and after (except where the block is at the beginning or end of the document):
-    Some text
-    ```
-    Code block
-    ```
-    ```
-    Another code block
-    ```
-    Some more text
-Rationale: Aside from aesthetic reasons, some parsers, including kramdown, will
-not parse fenced code blocks that don't have blank lines before and after them.
-## MD032 - Lists should be surrounded by blank lines
-Tags: bullet, ul, ol, blank_lines
-Aliases: blanks-around-lists
-This rule is triggered when lists (of any kind) are either not preceded or not
-followed by a blank line:
-    Some text
-    * Some
-    * List
-    1. Some
-    2. List
-    Some text
-To fix this, ensure that all lists have a blank line both before and after
-(except where the block is at the beginning or end of the document):
-    Some text
-    * Some
-    * List
-    1. Some
-    2. List
-    Some text
-Rationale: Aside from aesthetic reasons, some parsers, including kramdown, will
-not parse lists that don't have blank lines before and after them.
-Note: List items without hanging indents are a violation of this rule; list
-items with hanging indents are okay:
-    * This is
-    not okay
-    * This is
-      okay
-## MD033 - Inline HTML
-Tags: html
-Aliases: no-inline-html
-This rule is triggered whenever raw HTML is used in a markdown document:
-    <h1>Inline HTML header</h1>
-To fix this, use 'pure' markdown instead of including raw HTML:
-    # Markdown header
-Rationale: Raw HTML is allowed in markdown, but this rule is included for
-those who want their documents to only include "pure" markdown, or for those
-who are rendering markdown documents in something other than HTML.
-## MD034 - Bare URL used
-Tags: links, url
-Aliases: no-bare-urls
-This rule is triggered whenever a URL is given that isn't surrounded by angle
-brackets:
-    For more information, see http://www.example.com/.
-To fix this, add angle brackets around the URL:
-    For more information, see <http://www.example.com/>.
-Rationale: Without angle brackets, the URL isn't converted into a link in many
-markdown parsers.
-Note: if you do want a bare URL without it being converted into a link,
-enclose it in a code block, otherwise in some markdown parsers it _will_ be
-converted:
-    `http://www.example.com`
-## MD035 - Horizontal rule style
-Tags: hr
-Aliases: hr-style
-Parameters: style ("consistent", "---", "***", or other string specifying the
-horizontal rule; default "consistent")
-This rule is triggered when inconsistent styles of horizontal rules are used
-in the document:
-    ---
-    - - -
-    ***
-    * * *
-    ****
-To fix this, ensure any horizontal rules used in the document are consistent,
-or match the given style if the rule is so configured:
-    ---
-    ---
-Note: by default, this rule is configured to just require that all horizontal
-rules in the document are the same, and will trigger if any of the horizontal
-rules are different than the first one encountered in the document. If you
-want to configure the rule to match a specific style, the parameter given to
-the 'style' option is a string containing the exact horizontal rule text that
-is allowed.
-## MD036 - Emphasis used instead of a header
-Tags: headers, emphasis
-Parameters: punctuation (string; default ".,;:!?")
-Aliases: no-emphasis-as-header
-This check looks for instances where emphasized (i.e. bold or italic) text is
-used to separate sections, where a header should be used instead:
-    **My document**
-    Lorem ipsum dolor sit amet...
-    _Another section_
-    Consectetur adipiscing elit, sed do eiusmod.
-To fix this, use markdown headers instead of emphasized text to denote
-sections:
-    # My document
-    Lorem ipsum dolor sit amet...
-    ## Another section
-    Consectetur adipiscing elit, sed do eiusmod.
-Note: this rule looks for single line paragraphs that consist entirely of
-emphasized text.  It won't fire on emphasis used within regular text,
-multi-line emphasized paragraphs, and paragraphs ending in punctuation.
-Similarly to rule MD026, you can configure what characters are recognized as
-punctuation.
-## MD037 - Spaces inside emphasis markers
-Tags: whitespace, emphasis
-Aliases: no-space-in-emphasis
-This rule is triggered when emphasis markers (bold, italic) are used, but they
-have spaces between the markers and the text:
-    Here is some ** bold ** text.
-    Here is some * italic * text.
-    Here is some more __ bold __ text.
-    Here is some more _ italic _ text.
-To fix this, remove the spaces around the emphasis markers:
-    Here is some **bold** text.
-    Here is some *italic* text.
-    Here is some more __bold__ text.
-    Here is some more _italic_ text.
-Rationale: Emphasis is only parsed as such when the asterisks/underscores
-aren't completely surrounded by spaces. This rule attempts to detect where
-they were surrounded by spaces, but it appears that emphasized text was
-intended by the author.
-## MD038 - Spaces inside code span elements
-Tags: whitespace, code
-Aliases: no-space-in-code
-This rule is triggered on code span elements that have spaces right inside the
-backticks:
-    ` some text `
-    `some text `
-    ` some text`
-To fix this, remove the spaces inside the codespan markers:
-    `some text`
-## MD039 - Spaces inside link text
-Tags: whitespace, links
-Aliases: no-space-in-links
-This rule is triggered on links that have spaces surrounding the link text:
-    [ a link ](http://www.example.com/)
-To fix this, remove the spaces surrounding the link text:
-    [a link](http://www.example.com/)
-## MD040 - Fenced code blocks should have a language specified
-Tags: code, language
-Aliases: fenced-code-language
-This rule is triggered when fenced code blocks are used, but a language isn't
-specified:
-    ```
-    #!/bin/bash
-    echo Hello world
-    ```
-To fix this, add a language specifier to the code block:
-    ```bash
-    #!/bin/bash
-    echo Hello world
-    ```
-## MD041 - First line in file should be a top level header
-Tags: headers
-Aliases: first-line-h1
-Parameters: level (number; default 1)
-This rule is triggered when the first line in the file isn't a top level (h1)
-header:
-    ```
-    This is a file without a header
-    ```
-To fix this, add a header to the top of your file:
-    ```
-    # File with header
-    This is a file with a top level header
-    ```
-Note: The `level` parameter can be used to change the top level (ex: to h2) in
-cases where an h1 is added externally.
-## MD046 - Code block style
-Tags: code
-Aliases: code-block-style
-Parameters: style ("fenced", "indented", "consistent", default "fenced")
-This rule is truggered what a different code block style is used than the
-configured one. For example, in the default configuration this triggers:
-    Some text.
-        Code block
-    Some more text.
-To fix this, used fenced code blocks:
-    Some text.
-    ```ruby
-    Code block
-    ```
-    Some more text.
-Or the reverse for the `indented` style.