RubyGems - mdl - Versions diffs - 0.6.0 → 0.11.0 - Mend

mdl 0.6.0 → 0.11.0

Files changed (152) 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 +51 -58
data/lib/mdl/kramdown_parser.rb +1 -1
data/lib/mdl/rules.rb +222 -168
data/lib/mdl/ruleset.rb +11 -10
data/lib/mdl/style.rb +28 -12
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 +21 -18
metadata +75 -289
data/.gitignore +0 -13
data/.pre-commit-hooks.yaml +0 -6
data/.travis.yml +0 -12
data/CHANGELOG.md +0 -208
data/CONTRIBUTING.md +0 -7
data/MAINTAINERS.md +0 -21
data/README.md +0 -87
data/Rakefile +0 -8
data/docs/RULES.md +0 -1089
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 -42
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 -28
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

@@ -1,99 +0,0 @@
-# Mdl configuration
-Markdownlint has several options you can configure both on the command line,
-or in markdownlint's configuration file: `.mdlrc`, first looked for from the
-working directory, then in your home directory.
-While markdownlint will work perfectly well out of the box, this page
-documents some of the options you can change to suit your needs.
-In general, anything you pass on the command line can also be put into
-`~/.mdlrc` with the same option. For example, if you pass `--style foo` on the
-command line, you can make this the default by putting `style "foo"` into your
-`~/.mdlrc` file.
-## Configuration options
-### General options
-Verbose - Print additional information about what markdownlint is doing.
-* Command line: `-v`, `--verbose`
-* Config file: `verbose true`
-* Default: false
-Show warnings - Kramdown will generate warnings of its own for some issues
-found with documents during parsing, and markdownlint can print these out in
-addition to using the built in rules. This option enables/disables that
-behavior.
-* Command line: `-w`, `--warnings`
-* Config file: `show_kramdown_warnings true`
-* Default: true
-Recurse using files known to git - When mdl is given a directory name on the
-command line, it will recurse into that directory looking for markdown files
-to process. If this option is enabled, it will use git to look for files
-instead, and ignore any files git doesn't know about.
-* Command line: `-g`, `--git-recurse`
-* Config file: `git_recurse true`
-* Default: false
-Ignore YAML front matter - if this option is enabled markdownlint will ignore
-content within valid
-[YAML front matter](https://jekyllrb.com/docs/frontmatter/). Reported line
-numbers will still match the file contents but markdownlint will consider the
-line following front matter to be the first line.
-* Command line: `-i`, `--ignore-front-matter`
-* Config file: `ignore_front_matter true`
-* Default: false
-### Specifying which rules mdl processes
-Tags - Limit the rules mdl enables to those containing the provided tags.
-* Command line: `-t tag1,tag2`, `--tags tag1,tag2`, `-t ~tag1,~tag2`
-* Config file: `tags "tag1", "tag2"`
-* Default: process all rules (no tag limit)
-Rules - Limit the rules mdl enables to those provided in this option.
-* Command line: `-r MD001,MD002`, `--rules MD001,MD002`, `-r ~MD001,~MD002`
-* Config file: `rules "MD001", "MD002"`
-* Default: process all rules (no rule limit)
-If a rule or tag ID is preceded by a tilde (`~`), then it _disables_ the
-matching rules instead of enabling them, starting with all rules being enabled.
-Note: if both `--rules` and `--tags` are provided, then a given rule has to
-both be in the list of enabled rules, as well as be tagged with one of the
-tags provided with the `--tags` option. Use the `-l/--list-rules` option to
-test this behavior.
-Style - Select which style mdl uses. A 'style' is a file containing a list of
-enabled/disable rules, as well as options for some rules that take them. For
-example, one style might enforce a line length of 80 characters, while another
-might choose 72 characters, and another might have no line length limit at all
-(rule MD013).
-* Command line: `-s style_name`, `--style style_name`
-* Config file: `style "style_name"`
-* Default: Use the style called 'default'
-Note: the value for `style_name` must either end with `.rb` or have `/` in it
-in order to tell `mdl` to look for a custom style, and not a built-in style.
-Rulesets - Load a custom ruleset file. This option allows you to load custom
-rules in addition to those included with markdownlint.
-* Command line: `-u ruleset.rb,ruleset2.rb`, `--rules ruleset.rb,ruleset2.rb`
-* Config file: `rulesets 'ruleset.rb', 'ruleset2.rb'`
-* Default: Don't load any additional rulesets
-No default ruleset - Skip loading the default ruleset file included with
-markdownlint. Use this option if you only want to load custom rulesets.
-* Command line: `-d`, `--skip-default-ruleset`
-* Config file: `skip_default_ruleset true`
-* Default: Load the default ruleset.

data/docs/creating_rules.md DELETED

@@ -1,90 +0,0 @@
-# Creating Rules
-Rules are written in ruby, using a rule DSL for defining rules. A rule looks
-like:
-    rule "MY000", "Rule description" do
-      tags :foo, :bar
-      aliases 'rule-name'
-      params :style => :foo
-      check do |doc|
-        # check code goes here
-        # return a list of line numbers that break the rule, or an empty list
-        # (or nil) if there are no problems.
-      end
-    end
-The first line specifies the rule name and description. By convention, built
-in markdownlint rules use the prefix 'MD' followed by a number to identify
-rules. Any custom rules should use an alternate prefix to avoid conflicting
-with current or future rules. The description is simply a short description
-explaining what the rule is checking, which will be printed alongside the rule
-name when rules are triggered.
-Next, the rule's tags are specified. These are simply ruby symbols, and can be
-used by a user to limit which rules are checks. For example, if your rule
-checks whitespace usage in a document, you can add the `:whitespace` tag, and
-users who don't care about whitespace can exclude that tag on the command line
-or in style files.
-You can also specify aliases for the rule, which can be used to refer to the
-rule with a human-readable name rather than MD000. To do this, add then with
-the 'aliases' directive. Whenever you refer to a rule, such as for
-including/excluding in the configuration or in style files, you can use an
-alias for the rule instead of its ID.
-After that, any parameters the rule takes are specified. If your rule checks
-for a specific number of things, or if you can envision multiple variants of
-the same rule, then you should add parameters to allow your rule to be
-customized in a style file. Any parameters specified here are accessible
-inside the check itself using `params[:foo]`.
-Finally, the check itself is specified. This is simply a ruby block that
-should return a list of line numbers for any issues found. If no line numbers
-are found, you can either return an empty list, or nil, whichever is easiest
-for your check.
-## Document objects
-The check takes a single parameter `'doc'`, which is an object containing a
-representation of the markdown document along with several helper functions
-used for making rules. The [doc.rb](../lib/mdl/doc.rb) file is documented
-using rdoc, and you will want to take a look there to see all the methods you
-can use, as well as look at some of the existing rules, but a quick summary is
-as follows:
-* `doc` - Object containing a representation of the markdown document
-* `doc.lines` - The raw markdown file as an array of lines
-  * You can also look up a line given an element with
-    `doc.element_line(element)`
-* `doc.parsed` - The kramdown internal representation of the doc. Most of the
-  time you will want to interact with the parsed version of the document
-  rather than looking at `doc.lines`.
-* `doc.find_type_elements` - A method to find all elements of a given type.
-  You pass the type as a symbol, such as `:ul` or `:p`. Most element types
-  match the name of the element in HTML output. This method returns a list of
-  the matching elements.
-* `doc.find_type` - This is like `doc.find_type_elements`, but returns just
-  the options hashes (see below) for each element. This is useful if you don't
-  need all the element information, but you do need the line numbers.
-* `doc.element_line_number` - Pass in an element (or an options hash), and
-  this will return the line number for the element. You need to return the
-  line number in the list of errors.
-## Element objects
-The document contains an internal representation of the markdown document as
-parsed by kramdown. Kramdown's representation of the document is as a tree of
-'element' objects. The following is a quick summary of those objects:
-* element.type - a symbol denoting the type of the element, such as `:li`,
-  `:p`, `:text`
-* element.value - the value of the element. Note that most block level
-  elements such as paragraphs don't have any value themselves, but have child
-  text elements containing their contents instead.
-* element.children - A list of the element's child elements.
-* element.options - A hash containing:
-  * `:location` - line number of element
-  * `:element_level` - A value filled in by markdownlint to denote the nesting
-    level of the element, i.e. how deep in the tree is it.
-  * Other options that are element type specific.

data/docs/creating_styles.md DELETED

@@ -1,47 +0,0 @@
-# Creating styles
-A 'style' in markdownlint is simply a ruby file specifying the list of enabled
-and disabled rules, as well as specifying parameters for any rules that need
-parameters different than the defaults.
-The various options you can use in a style file are:
-* all - include all rules
-* rule - include a specific rule.
-        rule 'MD001'
-* exclude_rule - exclude a previously included rule. Used if you want to
-  include all except for a few rules.
-        exclude_rule 'MD000'
-* tag - include all rules that are tagged with a specific value
-        tag :whitespace
-* exclude_tag - exclude all rules tagged with the specified tag
-        exclude_tag :line_length
-Note that tags are specified as symbols, and rule names as strings, just as
-in the rule definitions themselves.
-The last matching option wins, so you should always put `'all'` at the top of
-the file (if you want to include all rules), then tags (and tag excludes),
-then specific rules. In other words, go from least to most specific.
-## Parameters
-If you specify any parameters after a rule ID, then those values will be used
-for the rules instead of the default. You only need to specify parameters for
-any values you wish to override. For example, the default values for the
-parameters in MD030 (spaces after list markers) are all 1. If you still want
-the spaces after the list markers to be 1 in some cases, then you can exclude
-those parameters:
-    rule 'MD030', :ol_multi => 2, :ul_multi => 3
-Even if a rule is included already by a tag specification (or 'all'), it is
-not a problem to add a specific 'rule' entry in order to set custom
-parameters, and is in fact necessary to do so.

data/docs/rolling_a_release.md DELETED

@@ -1,49 +0,0 @@
-# Rolling a new release
-Bump the version. Markdownlint uses semantic versioning. From
-<http://semver.org/>:
-* Major version for backwards-incompatible changes
-* Minor version functionality added in a backwards-compatible manner
-* Patch version for backwards-compatible bug fixes
-* Exception: Versions < 1.0 may introduce backwards-incompatible changes in a
-  minor version.
-To bump the version, edit `lib/mdl/version.rb` and commit to the master
-branch.
-Update the changelog:
-* Add a new header and link for the new release, replacing any 'Unreleased'
-  header.
-        ## [v0.2.0] (2015-04-13)
-        This goes at the bottom:
-        [v0.2.0]: https://github.com/markdownlint/markdownlint/tree/v0.2.0
-* Changelog entries can and should be added in an 'Unreleased' section as
-  commits are made. However, the following steps can be performed before each
-  release to catch anything that was missed.
-* Add a 'Rules added' section, listing every new rule added for this version.
-  * Use `git diff v0.1.0..v0.2.0 docs/RULES.md | grep '## MD'` to discover
-    what these are.
-* Search for closed issues:
-  * Go to <https://github.com/markdownlint/markdownlint/issues>
-  * Search for `closed:>1900-01-01`, changing the date to the date
-    of the last release.
-  * From this list of issues, make sections for:
-    * Added - for new features
-    * Changed - for changes in existing functionality
-    * Deprecated - for once-stable features removed in upcoming releases
-    * Removed - for deprecated features removed in this release
-    * Fixed - for any bug fixes
-    * Security - for any security issues
-Next, run `rake release`. This will:
-* Tag vX.Y.Z in git and push it.
-* Upload the new gem to rubygems.org
-Finally, add a new 'Unreleased' section to the changelog for the next release.

data/example/markdown_spec.md DELETED

@@ -1,897 +0,0 @@
-Markdown: Syntax
-================
-<ul id="ProjectSubmenu">
-    <li><a href="/projects/markdown/" title="Markdown Project Page">Main</a></li>
-    <li><a href="/projects/markdown/basics" title="Markdown Basics">Basics</a></li>
-    <li><a class="selected" title="Markdown Syntax Documentation">Syntax</a></li>
-    <li><a href="/projects/markdown/license" title="Pricing and License Information">License</a></li>
-    <li><a href="/projects/markdown/dingus" title="Online Markdown Web Form">Dingus</a></li>
-</ul>
-*   [Overview](#overview)
-    *   [Philosophy](#philosophy)
-    *   [Inline HTML](#html)
-    *   [Automatic Escaping for Special Characters](#autoescape)
-*   [Block Elements](#block)
-    *   [Paragraphs and Line Breaks](#p)
-    *   [Headers](#header)
-    *   [Blockquotes](#blockquote)
-    *   [Lists](#list)
-    *   [Code Blocks](#precode)
-    *   [Horizontal Rules](#hr)
-*   [Span Elements](#span)
-    *   [Links](#link)
-    *   [Emphasis](#em)
-    *   [Code](#code)
-    *   [Images](#img)
-*   [Miscellaneous](#misc)
-    *   [Backslash Escapes](#backslash)
-    *   [Automatic Links](#autolink)
-**Note:** This document is itself written using Markdown; you
-can [see the source for it by adding '.text' to the URL][src].
-  [src]: /projects/markdown/syntax.text
-* * *
-<h2 id="overview">Overview</h2>
-<h3 id="philosophy">Philosophy</h3>
-Markdown is intended to be as easy-to-read and easy-to-write as is feasible.
-Readability, however, is emphasized above all else. A Markdown-formatted
-document should be publishable as-is, as plain text, without looking
-like it's been marked up with tags or formatting instructions. While
-Markdown's syntax has been influenced by several existing text-to-HTML
-filters -- including [Setext] [1], [atx] [2], [Textile] [3], [reStructuredText] [4],
-[Grutatext] [5], and [EtText] [6] -- the single biggest source of
-inspiration for Markdown's syntax is the format of plain text email.
-  [1]: http://docutils.sourceforge.net/mirror/setext.html
-  [2]: http://www.aaronsw.com/2002/atx/
-  [3]: http://textism.com/tools/textile/
-  [4]: http://docutils.sourceforge.net/rst.html
-  [5]: http://www.triptico.com/software/grutatxt.html
-  [6]: http://ettext.taint.org/doc/
-To this end, Markdown's syntax is comprised entirely of punctuation
-characters, which punctuation characters have been carefully chosen so
-as to look like what they mean. E.g., asterisks around a word actually
-look like \*emphasis\*. Markdown lists look like, well, lists. Even
-blockquotes look like quoted passages of text, assuming you've ever
-used email.
-<h3 id="html">Inline HTML</h3>
-Markdown's syntax is intended for one purpose: to be used as a
-format for *writing* for the web.
-Markdown is not a replacement for HTML, or even close to it. Its
-syntax is very small, corresponding only to a very small subset of
-HTML tags. The idea is *not* to create a syntax that makes it easier
-to insert HTML tags. In my opinion, HTML tags are already easy to
-insert. The idea for Markdown is to make it easy to read, write, and
-edit prose. HTML is a *publishing* format; Markdown is a *writing*
-format. Thus, Markdown's formatting syntax only addresses issues that
-can be conveyed in plain text.
-For any markup that is not covered by Markdown's syntax, you simply
-use HTML itself. There's no need to preface it or delimit it to
-indicate that you're switching from Markdown to HTML; you just use
-the tags.
-The only restrictions are that block-level HTML elements -- e.g. `<div>`,
-`<table>`, `<pre>`, `<p>`, etc. -- must be separated from surrounding
-content by blank lines, and the start and end tags of the block should
-not be indented with tabs or spaces. Markdown is smart enough not
-to add extra (unwanted) `<p>` tags around HTML block-level tags.
-For example, to add an HTML table to a Markdown article:
-    This is a regular paragraph.
-    <table>
-        <tr>
-            <td>Foo</td>
-        </tr>
-    </table>
-    This is another regular paragraph.
-Note that Markdown formatting syntax is not processed within block-level
-HTML tags. E.g., you can't use Markdown-style `*emphasis*` inside an
-HTML block.
-Span-level HTML tags -- e.g. `<span>`, `<cite>`, or `<del>` -- can be
-used anywhere in a Markdown paragraph, list item, or header. If you
-want, you can even use HTML tags instead of Markdown formatting; e.g. if
-you'd prefer to use HTML `<a>` or `<img>` tags instead of Markdown's
-link or image syntax, go right ahead.
-Unlike block-level HTML tags, Markdown syntax *is* processed within
-span-level tags.
-<h3 id="autoescape">Automatic Escaping for Special Characters</h3>
-In HTML, there are two characters that demand special treatment: `<`
-and `&`. Left angle brackets are used to start tags; ampersands are
-used to denote HTML entities. If you want to use them as literal
-characters, you must escape them as entities, e.g. `&lt;`, and
-`&amp;`.
-Ampersands in particular are bedeviling for web writers. If you want to
-write about 'AT&T', you need to write '`AT&amp;T`'. You even need to
-escape ampersands within URLs. Thus, if you want to link to:
-    http://images.google.com/images?num=30&q=larry+bird
-you need to encode the URL as:
-    http://images.google.com/images?num=30&amp;q=larry+bird
-in your anchor tag `href` attribute. Needless to say, this is easy to
-forget, and is probably the single most common source of HTML validation
-errors in otherwise well-marked-up web sites.
-Markdown allows you to use these characters naturally, taking care of
-all the necessary escaping for you. If you use an ampersand as part of
-an HTML entity, it remains unchanged; otherwise it will be translated
-into `&amp;`.
-So, if you want to include a copyright symbol in your article, you can write:
-    &copy;
-and Markdown will leave it alone. But if you write:
-    AT&T
-Markdown will translate it to:
-    AT&amp;T
-Similarly, because Markdown supports [inline HTML](#html), if you use
-angle brackets as delimiters for HTML tags, Markdown will treat them as
-such. But if you write:
-    4 < 5
-Markdown will translate it to:
-    4 &lt; 5
-However, inside Markdown code spans and blocks, angle brackets and
-ampersands are *always* encoded automatically. This makes it easy to use
-Markdown to write about HTML code. (As opposed to raw HTML, which is a
-terrible format for writing about HTML syntax, because every single `<`
-and `&` in your example code needs to be escaped.)
-* * *
-<h2 id="block">Block Elements</h2>
-<h3 id="p">Paragraphs and Line Breaks</h3>
-A paragraph is simply one or more consecutive lines of text, separated
-by one or more blank lines. (A blank line is any line that looks like a
-blank line -- a line containing nothing but spaces or tabs is considered
-blank.) Normal paragraphs should not be indented with spaces or tabs.
-The implication of the "one or more consecutive lines of text" rule is
-that Markdown supports "hard-wrapped" text paragraphs. This differs
-significantly from most other text-to-HTML formatters (including Movable
-Type's "Convert Line Breaks" option) which translate every line break
-character in a paragraph into a `<br />` tag.
-When you *do* want to insert a `<br />` break tag using Markdown, you
-end a line with two or more spaces, then type return.
-Yes, this takes a tad more effort to create a `<br />`, but a simplistic
-"every line break is a `<br />`" rule wouldn't work for Markdown.
-Markdown's email-style [blockquoting][bq] and multi-paragraph [list items][l]
-work best -- and look better -- when you format them with hard breaks.
-  [bq]: #blockquote
-  [l]:  #list
-<h3 id="header">Headers</h3>
-Markdown supports two styles of headers, [Setext] [1] and [atx] [2].
-Setext-style headers are "underlined" using equal signs (for first-level
-headers) and dashes (for second-level headers). For example:
-    This is an H1
-    =============
-    This is an H2
-    -------------
-Any number of underlining `=`'s or `-`'s will work.
-Atx-style headers use 1-6 hash characters at the start of the line,
-corresponding to header levels 1-6. For example:
-    # This is an H1
-    ## This is an H2
-    ###### This is an H6
-Optionally, you may "close" atx-style headers. This is purely
-cosmetic -- you can use this if you think it looks better. The
-closing hashes don't even need to match the number of hashes
-used to open the header. (The number of opening hashes
-determines the header level.) :
-    # This is an H1 #
-    ## This is an H2 ##
-    ### This is an H3 ######
-<h3 id="blockquote">Blockquotes</h3>
-Markdown uses email-style `>` characters for blockquoting. If you're
-familiar with quoting passages of text in an email message, then you
-know how to create a blockquote in Markdown. It looks best if you hard
-wrap the text and put a `>` before every line:
-    > This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet,
-    > consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.
-    > Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.
-    >
-    > Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse
-    > id sem consectetuer libero luctus adipiscing.
-Markdown allows you to be lazy and only put the `>` before the first
-line of a hard-wrapped paragraph:
-    > This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet,
-    consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.
-    Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.
-    > Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse
-    id sem consectetuer libero luctus adipiscing.
-Blockquotes can be nested (i.e. a blockquote-in-a-blockquote) by
-adding additional levels of `>`:
-    > This is the first level of quoting.
-    >
-    > > This is nested blockquote.
-    >
-    > Back to the first level.
-Blockquotes can contain other Markdown elements, including headers, lists,
-and code blocks:
-	> ## This is a header.
-	>
-	> 1.   This is the first list item.
-	> 2.   This is the second list item.
-	>
-	> Here's some example code:
-	>
-	>     return shell_exec("echo $input | $markdown_script");
-Any decent text editor should make email-style quoting easy. For
-example, with BBEdit, you can make a selection and choose Increase
-Quote Level from the Text menu.
-<h3 id="list">Lists</h3>
-Markdown supports ordered (numbered) and unordered (bulleted) lists.
-Unordered lists use asterisks, pluses, and hyphens -- interchangably
--- as list markers:
-    *   Red
-    *   Green
-    *   Blue
-is equivalent to:
-    +   Red
-    +   Green
-    +   Blue
-and:
-    -   Red
-    -   Green
-    -   Blue
-Ordered lists use numbers followed by periods:
-    1.  Bird
-    2.  McHale
-    3.  Parish
-It's important to note that the actual numbers you use to mark the
-list have no effect on the HTML output Markdown produces. The HTML
-Markdown produces from the above list is:
-    <ol>
-    <li>Bird</li>
-    <li>McHale</li>
-    <li>Parish</li>
-    </ol>
-If you instead wrote the list in Markdown like this:
-    1.  Bird
-    1.  McHale
-    1.  Parish
-or even:
-    3. Bird
-    1. McHale
-    8. Parish
-you'd get the exact same HTML output. The point is, if you want to,
-you can use ordinal numbers in your ordered Markdown lists, so that
-the numbers in your source match the numbers in your published HTML.
-But if you want to be lazy, you don't have to.
-If you do use lazy list numbering, however, you should still start the
-list with the number 1. At some point in the future, Markdown may support
-starting ordered lists at an arbitrary number.
-List markers typically start at the left margin, but may be indented by
-up to three spaces. List markers must be followed by one or more spaces
-or a tab.
-To make lists look nice, you can wrap items with hanging indents:
-    *   Lorem ipsum dolor sit amet, consectetuer adipiscing elit.
-        Aliquam hendrerit mi posuere lectus. Vestibulum enim wisi,
-        viverra nec, fringilla in, laoreet vitae, risus.
-    *   Donec sit amet nisl. Aliquam semper ipsum sit amet velit.
-        Suspendisse id sem consectetuer libero luctus adipiscing.
-But if you want to be lazy, you don't have to:
-    *   Lorem ipsum dolor sit amet, consectetuer adipiscing elit.
-    Aliquam hendrerit mi posuere lectus. Vestibulum enim wisi,
-    viverra nec, fringilla in, laoreet vitae, risus.
-    *   Donec sit amet nisl. Aliquam semper ipsum sit amet velit.
-    Suspendisse id sem consectetuer libero luctus adipiscing.
-If list items are separated by blank lines, Markdown will wrap the
-items in `<p>` tags in the HTML output. For example, this input:
-    *   Bird
-    *   Magic
-will turn into:
-    <ul>
-    <li>Bird</li>
-    <li>Magic</li>
-    </ul>
-But this:
-    *   Bird
-    *   Magic
-will turn into:
-    <ul>
-    <li><p>Bird</p></li>
-    <li><p>Magic</p></li>
-    </ul>
-List items may consist of multiple paragraphs. Each subsequent
-paragraph in a list item must be indented by either 4 spaces
-or one tab:
-    1.  This is a list item with two paragraphs. Lorem ipsum dolor
-        sit amet, consectetuer adipiscing elit. Aliquam hendrerit
-        mi posuere lectus.
-        Vestibulum enim wisi, viverra nec, fringilla in, laoreet
-        vitae, risus. Donec sit amet nisl. Aliquam semper ipsum
-        sit amet velit.
-    2.  Suspendisse id sem consectetuer libero luctus adipiscing.
-It looks nice if you indent every line of the subsequent
-paragraphs, but here again, Markdown will allow you to be
-lazy:
-    *   This is a list item with two paragraphs.
-        This is the second paragraph in the list item. You're
-    only required to indent the first line. Lorem ipsum dolor
-    sit amet, consectetuer adipiscing elit.
-    *   Another item in the same list.
-To put a blockquote within a list item, the blockquote's `>`
-delimiters need to be indented:
-    *   A list item with a blockquote:
-        > This is a blockquote
-        > inside a list item.
-To put a code block within a list item, the code block needs
-to be indented *twice* -- 8 spaces or two tabs:
-    *   A list item with a code block:
-            <code goes here>
-It's worth noting that it's possible to trigger an ordered list by
-accident, by writing something like this:
-    1986. What a great season.
-In other words, a *number-period-space* sequence at the beginning of a
-line. To avoid this, you can backslash-escape the period:
-    1986\. What a great season.
-<h3 id="precode">Code Blocks</h3>
-Pre-formatted code blocks are used for writing about programming or
-markup source code. Rather than forming normal paragraphs, the lines
-of a code block are interpreted literally. Markdown wraps a code block
-in both `<pre>` and `<code>` tags.
-To produce a code block in Markdown, simply indent every line of the
-block by at least 4 spaces or 1 tab. For example, given this input:
-    This is a normal paragraph:
-        This is a code block.
-Markdown will generate:
-    <p>This is a normal paragraph:</p>
-    <pre><code>This is a code block.
-    </code></pre>
-One level of indentation -- 4 spaces or 1 tab -- is removed from each
-line of the code block. For example, this:
-    Here is an example of AppleScript:
-        tell application "Foo"
-            beep
-        end tell
-will turn into:
-    <p>Here is an example of AppleScript:</p>
-    <pre><code>tell application "Foo"
-        beep
-    end tell
-    </code></pre>
-A code block continues until it reaches a line that is not indented
-(or the end of the article).
-Within a code block, ampersands (`&`) and angle brackets (`<` and `>`)
-are automatically converted into HTML entities. This makes it very
-easy to include example HTML source code using Markdown -- just paste
-it and indent it, and Markdown will handle the hassle of encoding the
-ampersands and angle brackets. For example, this:
-        <div class="footer">
-            &copy; 2004 Foo Corporation
-        </div>
-will turn into:
-    <pre><code>&lt;div class="footer"&gt;
-        &amp;copy; 2004 Foo Corporation
-    &lt;/div&gt;
-    </code></pre>
-Regular Markdown syntax is not processed within code blocks. E.g.,
-asterisks are just literal asterisks within a code block. This means
-it's also easy to use Markdown to write about Markdown's own syntax.
-<h3 id="hr">Horizontal Rules</h3>
-You can produce a horizontal rule tag (`<hr />`) by placing three or
-more hyphens, asterisks, or underscores on a line by themselves. If you
-wish, you may use spaces between the hyphens or asterisks. Each of the
-following lines will produce a horizontal rule:
-    * * *
-    ***
-    *****
-    - - -
-    ---------------------------------------
-* * *
-<h2 id="span">Span Elements</h2>
-<h3 id="link">Links</h3>
-Markdown supports two style of links: *inline* and *reference*.
-In both styles, the link text is delimited by [square brackets].
-To create an inline link, use a set of regular parentheses immediately
-after the link text's closing square bracket. Inside the parentheses,
-put the URL where you want the link to point, along with an *optional*
-title for the link, surrounded in quotes. For example:
-    This is [an example](http://example.com/ "Title") inline link.
-    [This link](http://example.net/) has no title attribute.
-Will produce:
-    <p>This is <a href="http://example.com/" title="Title">
-    an example</a> inline link.</p>
-    <p><a href="http://example.net/">This link</a> has no
-    title attribute.</p>
-If you're referring to a local resource on the same server, you can
-use relative paths:
-    See my [About](/about/) page for details.
-Reference-style links use a second set of square brackets, inside
-which you place a label of your choosing to identify the link:
-    This is [an example][id] reference-style link.
-You can optionally use a space to separate the sets of brackets:
-    This is [an example] [id] reference-style link.
-Then, anywhere in the document, you define your link label like this,
-on a line by itself:
-    [id]: http://example.com/  "Optional Title Here"
-That is:
-*   Square brackets containing the link identifier (optionally
-    indented from the left margin using up to three spaces);
-*   followed by a colon;
-*   followed by one or more spaces (or tabs);
-*   followed by the URL for the link;
-*   optionally followed by a title attribute for the link, enclosed
-    in double or single quotes, or enclosed in parentheses.
-The following three link definitions are equivalent:
-	[foo]: http://example.com/  "Optional Title Here"
-	[foo]: http://example.com/  'Optional Title Here'
-	[foo]: http://example.com/  (Optional Title Here)
-**Note:** There is a known bug in Markdown.pl 1.0.1 which prevents
-single quotes from being used to delimit link titles.
-The link URL may, optionally, be surrounded by angle brackets:
-    [id]: <http://example.com/>  "Optional Title Here"
-You can put the title attribute on the next line and use extra spaces
-or tabs for padding, which tends to look better with longer URLs:
-    [id]: http://example.com/longish/path/to/resource/here
-        "Optional Title Here"
-Link definitions are only used for creating links during Markdown
-processing, and are stripped from your document in the HTML output.
-Link definition names may consist of letters, numbers, spaces, and
-punctuation -- but they are *not* case sensitive. E.g. these two
-links:
-	[link text][a]
-	[link text][A]
-are equivalent.
-The *implicit link name* shortcut allows you to omit the name of the
-link, in which case the link text itself is used as the name.
-Just use an empty set of square brackets -- e.g., to link the word
-"Google" to the google.com web site, you could simply write:
-	[Google][]
-And then define the link:
-	[Google]: http://google.com/
-Because link names may contain spaces, this shortcut even works for
-multiple words in the link text:
-	Visit [Daring Fireball][] for more information.
-And then define the link:
-	[Daring Fireball]: http://daringfireball.net/
-Link definitions can be placed anywhere in your Markdown document. I
-tend to put them immediately after each paragraph in which they're
-used, but if you want, you can put them all at the end of your
-document, sort of like footnotes.
-Here's an example of reference links in action:
-    I get 10 times more traffic from [Google] [1] than from
-    [Yahoo] [2] or [MSN] [3].
-      [1]: http://google.com/        "Google"
-      [2]: http://search.yahoo.com/  "Yahoo Search"
-      [3]: http://search.msn.com/    "MSN Search"
-Using the implicit link name shortcut, you could instead write:
-    I get 10 times more traffic from [Google][] than from
-    [Yahoo][] or [MSN][].
-      [google]: http://google.com/        "Google"
-      [yahoo]:  http://search.yahoo.com/  "Yahoo Search"
-      [msn]:    http://search.msn.com/    "MSN Search"
-Both of the above examples will produce the following HTML output:
-    <p>I get 10 times more traffic from <a href="http://google.com/"
-    title="Google">Google</a> than from
-    <a href="http://search.yahoo.com/" title="Yahoo Search">Yahoo</a>
-    or <a href="http://search.msn.com/" title="MSN Search">MSN</a>.</p>
-For comparison, here is the same paragraph written using
-Markdown's inline link style:
-    I get 10 times more traffic from [Google](http://google.com/ "Google")
-    than from [Yahoo](http://search.yahoo.com/ "Yahoo Search") or
-    [MSN](http://search.msn.com/ "MSN Search").
-The point of reference-style links is not that they're easier to
-write. The point is that with reference-style links, your document
-source is vastly more readable. Compare the above examples: using
-reference-style links, the paragraph itself is only 81 characters
-long; with inline-style links, it's 176 characters; and as raw HTML,
-it's 234 characters. In the raw HTML, there's more markup than there
-is text.
-With Markdown's reference-style links, a source document much more
-closely resembles the final output, as rendered in a browser. By
-allowing you to move the markup-related metadata out of the paragraph,
-you can add links without interrupting the narrative flow of your
-prose.
-<h3 id="em">Emphasis</h3>
-Markdown treats asterisks (`*`) and underscores (`_`) as indicators of
-emphasis. Text wrapped with one `*` or `_` will be wrapped with an
-HTML `<em>` tag; double `*`'s or `_`'s will be wrapped with an HTML
-`<strong>` tag. E.g., this input:
-    *single asterisks*
-    _single underscores_
-    **double asterisks**
-    __double underscores__
-will produce:
-    <em>single asterisks</em>
-    <em>single underscores</em>
-    <strong>double asterisks</strong>
-    <strong>double underscores</strong>
-You can use whichever style you prefer; the lone restriction is that
-the same character must be used to open and close an emphasis span.
-Emphasis can be used in the middle of a word:
-    un*frigging*believable
-But if you surround an `*` or `_` with spaces, it'll be treated as a
-literal asterisk or underscore.
-To produce a literal asterisk or underscore at a position where it
-would otherwise be used as an emphasis delimiter, you can backslash
-escape it:
-    \*this text is surrounded by literal asterisks\*
-<h3 id="code">Code</h3>
-To indicate a span of code, wrap it with backtick quotes (`` ` ``).
-Unlike a pre-formatted code block, a code span indicates code within a
-normal paragraph. For example:
-    Use the `printf()` function.
-will produce:
-    <p>Use the <code>printf()</code> function.</p>
-To include a literal backtick character within a code span, you can use
-multiple backticks as the opening and closing delimiters:
-    ``There is a literal backtick (`) here.``
-which will produce this:
-    <p><code>There is a literal backtick (`) here.</code></p>
-The backtick delimiters surrounding a code span may include spaces --
-one after the opening, one before the closing. This allows you to place
-literal backtick characters at the beginning or end of a code span:
-	A single backtick in a code span: `` ` ``
-	A backtick-delimited string in a code span: `` `foo` ``
-will produce:
-	<p>A single backtick in a code span: <code>`</code></p>
-	<p>A backtick-delimited string in a code span: <code>`foo`</code></p>
-With a code span, ampersands and angle brackets are encoded as HTML
-entities automatically, which makes it easy to include example HTML
-tags. Markdown will turn this:
-    Please don't use any `<blink>` tags.
-into:
-    <p>Please don't use any <code>&lt;blink&gt;</code> tags.</p>
-You can write this:
-    `&#8212;` is the decimal-encoded equivalent of `&mdash;`.
-to produce:
-    <p><code>&amp;#8212;</code> is the decimal-encoded
-    equivalent of <code>&amp;mdash;</code>.</p>
-<h3 id="img">Images</h3>
-Admittedly, it's fairly difficult to devise a "natural" syntax for
-placing images into a plain text document format.
-Markdown uses an image syntax that is intended to resemble the syntax
-for links, allowing for two styles: *inline* and *reference*.
-Inline image syntax looks like this:
-    ![Alt text](/path/to/img.jpg)
-    ![Alt text](/path/to/img.jpg "Optional title")
-That is:
-*   An exclamation mark: `!`;
-*   followed by a set of square brackets, containing the `alt`
-    attribute text for the image;
-*   followed by a set of parentheses, containing the URL or path to
-    the image, and an optional `title` attribute enclosed in double
-    or single quotes.
-Reference-style image syntax looks like this:
-    ![Alt text][id]
-Where "id" is the name of a defined image reference. Image references
-are defined using syntax identical to link references:
-    [id]: url/to/image  "Optional title attribute"
-As of this writing, Markdown has no syntax for specifying the
-dimensions of an image; if this is important to you, you can simply
-use regular HTML `<img>` tags.
-* * *
-<h2 id="misc">Miscellaneous</h2>
-<h3 id="autolink">Automatic Links</h3>
-Markdown supports a shortcut style for creating "automatic" links for URLs and email addresses: simply surround the URL or email address with angle brackets. What this means is that if you want to show the actual text of a URL or email address, and also have it be a clickable link, you can do this:
-    <http://example.com/>
-Markdown will turn this into:
-    <a href="http://example.com/">http://example.com/</a>
-Automatic links for email addresses work similarly, except that
-Markdown will also perform a bit of randomized decimal and hex
-entity-encoding to help obscure your address from address-harvesting
-spambots. For example, Markdown will turn this:
-    <address@example.com>
-into something like this:
-    <a href="&#x6D;&#x61;i&#x6C;&#x74;&#x6F;:&#x61;&#x64;&#x64;&#x72;&#x65;
-    &#115;&#115;&#64;&#101;&#120;&#x61;&#109;&#x70;&#x6C;e&#x2E;&#99;&#111;
-    &#109;">&#x61;&#x64;&#x64;&#x72;&#x65;&#115;&#115;&#64;&#101;&#120;&#x61;
-    &#109;&#x70;&#x6C;e&#x2E;&#99;&#111;&#109;</a>
-which will render in a browser as a clickable link to "address@example.com".
-(This sort of entity-encoding trick will indeed fool many, if not
-most, address-harvesting bots, but it definitely won't fool all of
-them. It's better than nothing, but an address published in this way
-will probably eventually start receiving spam.)
-<h3 id="backslash">Backslash Escapes</h3>
-Markdown allows you to use backslash escapes to generate literal
-characters which would otherwise have special meaning in Markdown's
-formatting syntax. For example, if you wanted to surround a word
-with literal asterisks (instead of an HTML `<em>` tag), you can use
-backslashes before the asterisks, like this:
-    \*literal asterisks\*
-Markdown provides backslash escapes for the following characters:
-    \   backslash
-    `   backtick
-    *   asterisk
-    _   underscore
-    {}  curly braces
-    []  square brackets
-    ()  parentheses
-    #   hash mark
-	+	plus sign
-	-	minus sign (hyphen)
-    .   dot
-    !   exclamation mark