Merge pull request #104 from github/html-proofer

Set up HTML::Proofer

CONTRIBUTING.md

@@ -30,3 +30,12 @@ changes, type in a commit message, and click the `Propose File Change` button.
 That’s it!
 
 For more advanced changes, check out [the bootstrap instructions](https://github.com/github/choosealicense.com#run-it-on-your-machine) in the [project's readme](https://github.com/github/choosealicense.com/blob/master/README.md).
+
+## Testing
+
+[HTML::Proofer](https://github.com/gjtorikian/html-proofer) is set up to validate all links within the project.  You can run this locally to ensure that your changes are valid:
+
+```shell
+./script/bootstrap
+./script/cibuild
+```

Gemfile

@@ -2,3 +2,8 @@ source 'https://rubygems.org'
 ruby File.read('.ruby-version').strip
 
 gem "github-pages"
+
+group :test do
+  gem "html-proofer"
+  gem "rake"
+end

Gemfile.lock

@@ -5,10 +5,15 @@ GEM
     classifier (1.3.3)
       fast-stemmer (>= 1.0.0)
     colorator (0.1)
+    colored (1.2)
     commander (4.1.5)
       highline (~> 1.6.11)
     directory_watcher (1.4.1)
+    ethon (0.6.1)
+      ffi (>= 1.3.0)
+      mime-types (~> 1.18)
     fast-stemmer (1.0.2)
+    ffi (1.9.0)
     github-pages (4)
       RedCloth (= 4.2.9)
       jekyll (= 1.1.2)
@@ -18,6 +23,10 @@ GEM
       rdiscount (= 1.6.8)
       redcarpet (= 2.2.2)
     highline (1.6.19)
+    html-proofer (0.1.1)
+      colored (~> 1.2)
+      nokogiri (= 1.6.0)
+      typhoeus (~> 0.6.3)
     jekyll (1.1.2)
       classifier (~> 1.3)
       colorator (~> 0.1)
@@ -33,14 +42,21 @@ GEM
     liquid (2.5.1)
     maruku (0.6.1)
       syntax (>= 1.0.0)
+    mime-types (1.25)
+    mini_portile (0.5.1)
+    nokogiri (1.6.0)
+      mini_portile (~> 0.5.0)
     posix-spawn (0.3.6)
     pygments.rb (0.5.2)
       posix-spawn (~> 0.3.6)
       yajl-ruby (~> 1.1.0)
+    rake (10.1.0)
     rdiscount (1.6.8)
     redcarpet (2.2.2)
     safe_yaml (0.7.1)
     syntax (1.0.0)
+    typhoeus (0.6.5)
+      ethon (~> 0.6.1)
     yajl-ruby (1.1.0)
 
 PLATFORMS
@@ -48,3 +64,5 @@ PLATFORMS
 
 DEPENDENCIES
   github-pages
+  html-proofer
+  rake

Rakefile

@@ -0,0 +1,7 @@
+require "html/proofer"
+
+task :test do
+  sh "bundle exec jekyll build --trace"
+  # ignore href="#" for the "Copy to clipboard" button
+  HTML::Proofer.new("./_site", :href_ignore => ["#"]).run
+end

index.html

@@ -14,7 +14,7 @@ description: A site to provide non-judgmental guidance on choosing a license for
 <ul class="triptych situations cf">
   <li class='whatever'>
     <a href="licenses/mit">
-      <img height='57' src='images/three-arrows@2x.png' width='72'>
+      <img height='57' src='images/three-arrows@2x.png' width='72' alt='three arrows'>
       <h3>I want it simple and permissive.</h3>
     </a>
     <p>
@@ -26,7 +26,7 @@ description: A site to provide non-judgmental guidance on choosing a license for
   </li>
   <li class='patents'>
     <a href="licenses/apache">
-      <img height='72' src='images/lightbulb@2x.png' width='43'>
+      <img height='72' src='images/lightbulb@2x.png' width='43' alt='light bulb'>
       <h3>I’m concerned about patents.</h3>
     </a>
     <p>
@@ -38,7 +38,7 @@ description: A site to provide non-judgmental guidance on choosing a license for
   </li>
   <li class='copyleft'>
     <a href="licenses/gpl-v2">
-      <img height='69' src='images/circular@2x.png' width='72'>
+      <img height='69' src='images/circular@2x.png' width='72' alt='circular arrows'>
       <h3>I care about sharing improvements.</h3>
     </a>
     <p>

script/cibuild

@@ -6,4 +6,4 @@ echo "compiling javascript..."
 ./node_modules/.bin/coffee -c javascripts/app.coffee
 
 echo "building the site..."
-bundle exec jekyll build --trace
+bundle exec rake test