diff --git a/README.md b/README.md index fc1a1560..b20cebed 100644 --- a/README.md +++ b/README.md @@ -140,6 +140,8 @@ The `HTML::Proofer` constructor takes an optional hash of additional options: | `alt_ignore` | An array of Strings or RegExps containing `img`s whose missing `alt` tags are safe to ignore. | `[]` | | `empty_alt_ignore` | If `true`, ignores images with empty alt tags. | `false` | | `check_external_hash` | Checks whether external hashes exist (even if the website exists). This slows the checker down. | `false` | +| `check_favicon` | Enables the favicon checker. | `false` | +| `check_html` | Enables HTML validation errors from Nokogiri | `false` | |`checks_to_ignore`| An array of Strings indicating which checks you'd like to not perform. | `[]` | `directory_index_file` | Sets the file to look for when a link refers to a directory. | `index.html` | | `disable_external` | If `true`, does not run the external link checker, which can take a lot of time. | `false` | @@ -151,8 +153,6 @@ The `HTML::Proofer` constructor takes an optional hash of additional options: | `ignore_script_embeds` | When `check_html` is enabled, `script` tags containing markup [are reported as errors](http://git.io/vOovv). Enabling this option ignores those errors. | `false` | `only_4xx` | Only reports errors for links that fall within the 4xx status code range. | `false` | | `url_ignore` | An array of Strings or RegExps containing URLs that are safe to ignore. It affects all HTML attributes. Note that non-HTTP(S) URIs are always ignored. | `[]` | -| `check_favicon` | Enables the favicon checker. | `false` | -| `check_html` | Enables HTML validation errors from Nokogiri | `false` | | `verbose` | If `true`, outputs extra information as the checking happens. Useful for debugging. | `false` | ### Configuring Typhoeus and Hydra diff --git a/bin/htmlproof b/bin/htmlproof index 46be7a83..f1b16cb7 100755 --- a/bin/htmlproof +++ b/bin/htmlproof @@ -27,6 +27,8 @@ Mercenary.program(:htmlproof) do |p| p.option 'empty_alt_ignore', '--empty-alt-ignore', 'Ignores images with empty alt tags.' p.option 'checks_to_ignore', '--checks-to-ignore check1,[check2,...]', Array, ' An array of Strings indicating which checks you\'d like to not perform.' p.option 'check_external_hash', '--check-external-hash', 'Checks whether external hashes exist (even if the website exists). This slows the checker down (default: `false`).' + p.option 'check_favicon', '--check-favicon', 'Enables the favicon checker (default: `false`).' + p.option 'check_html', '--check-html', 'Enables HTML validation errors from Nokogiri (default: `false`).' p.option 'directory_index_file', '--directory-index-file', String, 'Sets the file to look for when a link refers to a directory. (default: `index.html`)' p.option 'disable_external', '--disable-external', 'Disables the external link checker (default: `false`)' p.option 'error_sort', '--error-sort SORT', 'Defines the sort order for error output. Can be `path`, `desc`, or `status` (default: `path`).' @@ -36,8 +38,6 @@ Mercenary.program(:htmlproof) do |p| p.option 'href_swap', '--href-swap re:string,[re:string,...]', Array, 'Comma-separated list of key-value pairs of `RegExp:String`. Transforms links matching `RegExp` into `String`' p.option 'ignore_script_errors', '--ignore-script-errors', 'Ignore `check_html` errors associated with `script`s (default: `false`)' p.option 'only_4xx', '--only-4xx', 'Only reports errors for links that fall within the 4x status code range.' - p.option 'check_favicon', '--check-favicon', 'Enables the favicon checker (default: `false`).' - p.option 'check_html', '--check-html', 'Enables HTML validation errors from Nokogiri (default: `false`).' p.option 'url_ignore', '--url-ignore link1,[link2,...]', Array, 'Comma-separated list of Strings or RegExps containing URLs that are safe to ignore.' p.option 'verbose', '--verbose', 'Enables more verbose logging.'