README.md in html-proofer-0.1.0 vs README.md in html-proofer-0.1.1
- old
+ new
@@ -1,12 +1,12 @@
# HTML::Proofer
-Generate HTML files? Use them for documentation? Great, then this tool might be for you.
+If you generate HTML files, _then this tool might be for you_.
-Here are a set of tests to validate your HTML output. These tests check if your image references are legitimate, if they have alt tags, if your internal links are working, and so on. It's intended to be an all-in-one checker for your documentation output.
+`HTML::Proofer` is a set of tests to validate your HTML output. These tests check if your image references are legitimate, if they have alt tags, if your internal links are working, and so on. It's intended to be an all-in-one checker for your output.
-[](https://travis-ci.org/gjtorikian/html-proofer)
+[](https://travis-ci.org/gjtorikian/html-proofer) [](http://badge.fury.io/rb/html-proofer)
## Installation
Add this line to your application's Gemfile:
@@ -21,11 +21,11 @@
$ gem install html-proofer
## Usage
Require the gem; generate some HTML; create a new instance of the `HTML::Proofer` on
-your out folder; then `run` it:
+your output folder; then `run` it. Here's a simple example:
```ruby
require 'html/proofer'
require 'html/pipeline'
require 'find'
@@ -47,22 +47,37 @@
File.open("out/#{path.split("/").pop.sub('.md', '.html')}", 'w') { |file| file.write(result[:output].to_s) }
end
end
# test your out dir!
-tester = HTML::Proofer.new("./out")
-tester.run
+HTML::Proofer.new("./out").run
```
-The `HTML::Proofer` constructor takes an optional hash of additional options:
+## Usage with Jekyll
-* `:ext`: the extension (including the `.`) of your HTML files (default: `.html`)
-* `:href_swap`: a hash containing key-value pairs of `RegExp => String`. It transforms links that match `RegExp` into `String` via `gsub`.
-* `:href_ignore`: an array of Strings containing `href`s that are safe to ignore (default: `mailto`)
+Want to use HTML Proofer with your Jekyll site? Awesome. Simply add `gem 'html-proofer'` to your `Gemfile` as described above, and add the following to your `Rakefile`, using `rake test` to execute:
+```ruby
+require 'html/proofer'
+
+task :test do
+ sh "bundle exec jekyll build"
+ HTML::Proofer.new("./_site").run
+end
+```
+
## What's Tested?
* Whether all your images have alt tags
* Whether your internal image references are not broken
* Whether external images are showing
* Whether your internal links are not broken; this includes hash references (`#linkToMe`)
* Whether external links are working
+
+## Configuration
+
+
+The `HTML::Proofer` constructor takes an optional hash of additional options:
+
+* `:ext`: the extension (including the `.`) of your HTML files (default: `.html`)
+* `:href_swap`: a hash containing key-value pairs of `RegExp => String`. It transforms links that match `RegExp` into `String` via `gsub`.
+* `:href_ignore`: an array of Strings containing `href`s that are safe to ignore (default: `mailto`)