html-proof ~> htmlproof

This commit is contained in:
Parker Moore 2014-06-27 15:43:37 -04:00
parent bd4a8c1ce2
commit eab113e4f5
1 changed files with 4 additions and 4 deletions

View File

@ -33,7 +33,7 @@ does ensure things are built properly.
When testing Jekyll output, there is no better tool than [html-proofer][2]. When testing Jekyll output, there is no better tool than [html-proofer][2].
This tool checks your resulting site to ensure all links and images exist. This tool checks your resulting site to ensure all links and images exist.
Utilize it either with the convenient `html-proof` command-line executable, Utilize it either with the convenient `htmlproof` command-line executable,
or write a Ruby script which utilizes the gem. or write a Ruby script which utilizes the gem.
### The HTML Proofer Executable ### The HTML Proofer Executable
@ -42,12 +42,12 @@ or write a Ruby script which utilizes the gem.
#!/usr/bin/env bash #!/usr/bin/env bash
jekyll build jekyll build
html-proof ./_site htmlproof ./_site
{% endhighlight %} {% endhighlight %}
Some options can be specified via command-line switches. Check out the Some options can be specified via command-line switches. Check out the
`html-proofer` README for more information about these switches, or run `html-proofer` README for more information about these switches, or run
`html-proof --help` locally. `htmlproof --help` locally.
### The HTML Proofer Library ### The HTML Proofer Library
@ -119,7 +119,7 @@ customizable. If your script won't change much, you can write your test
incantation here directly: incantation here directly:
{% highlight yaml %} {% highlight yaml %}
script: jekyll build && html-proof ./_site script: jekyll build && htmlproof ./_site
{% endhighlight %} {% endhighlight %}
The `script` directive can be absolutely any valid shell command. The `script` directive can be absolutely any valid shell command.