Merge pull request github#435 from github/add-html-proofer-tests

gjtorikian · gjtorikian · commit 843b4fb0cfbc · 2014-02-12T11:12:05.000-08:00
Add HTML::Proofer tests
diff --git a/.gitignore b/.gitignore
@@ -4,3 +4,6 @@ tmp
 .bundle
 bin
 crash.log
+/vendor/gems/
+/bin/
+/.bundle/
diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 1.9.3
diff --git a/Gemfile b/Gemfile
@@ -7,7 +7,7 @@ gem 'coderay'
 gem 'kramdown', '~> 0.13.2'
 gem 'mime-types', '~> 1.16'
 gem 'nanoc', '~> 3.4.3'
-gem 'nokogiri', '~> 1.4.4'
+gem 'nokogiri', '~> 1.6.0'
 gem 'pygments.rb'
 gem 'rake', '~> 0.9.2'
 gem 'thin'
@@ -17,3 +17,7 @@ group :development do
   gem 'adsf'
   gem 'fssm'
 end
+
+group :test do
+  gem 'html-proofer', '~> 0.6.0'
+end
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -1,34 +1,47 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    adsf (1.1.1)
+    adsf (1.2.0)
       rack (>= 1.0.0)
     blankslate (3.1.2)
     builder (3.2.2)
-    coderay (1.0.9)
+    coderay (1.1.0)
     colored (1.2)
-    cri (2.3.0)
+    cri (2.4.1)
       colored (>= 1.2)
     daemons (1.1.9)
+    ethon (0.6.2)
+      ffi (>= 1.3.0)
+      mime-types (~> 1.18)
     eventmachine (1.0.3)
-    ffi (1.0.11)
+    ffi (1.9.3)
     fssm (0.2.10)
+    html-proofer (0.6.0)
+      colored (~> 1.2)
+      mercenary (~> 0.2.0)
+      nokogiri (~> 1.6.0)
+      typhoeus (~> 0.6.7)
     kramdown (0.13.8)
-    mime-types (1.23)
+    mercenary (0.2.1)
+    mime-types (1.25.1)
+    mini_portile (0.5.2)
     nanoc (3.4.3)
       cri (~> 2.2)
-    nokogiri (1.4.7)
-    pygments.rb (0.2.13)
-      rubypython (~> 0.5.3)
+    nokogiri (1.6.1)
+      mini_portile (~> 0.5.0)
+    pygments.rb (0.2.3)
+      rubypython (>= 0.5.1)
     rack (1.5.2)
     rake (0.9.6)
-    rubypython (0.5.3)
+    rubypython (0.6.3)
       blankslate (>= 2.1.2.3)
-      ffi (~> 1.0.7)
-    thin (1.5.1)
+      ffi (>= 1.0.7)
+    thin (1.6.1)
       daemons (>= 1.0.9)
-      eventmachine (>= 0.12.6)
+      eventmachine (>= 1.0.0)
       rack (>= 1.0.0)
+    typhoeus (0.6.7)
+      ethon (~> 0.6.2)
     yajl-ruby (0.8.3)
 
 PLATFORMS
@@ -39,10 +52,11 @@ DEPENDENCIES
   builder
   coderay
   fssm
+  html-proofer (~> 0.6.0)
   kramdown (~> 0.13.2)
   mime-types (~> 1.16)
   nanoc (~> 3.4.3)
-  nokogiri (~> 1.4.4)
+  nokogiri (~> 1.6.0)
   pygments.rb
   rake (~> 0.9.2)
   thin
diff --git a/Rakefile b/Rakefile
@@ -1,10 +1,18 @@
 require 'nanoc3/tasks'
+require 'html/proofer'
+
+task :default => [:test]
 
 desc "Compile the site"
 task :compile do
   `nanoc compile`
 end
 
+desc "Test the output"
+task :test => [:clean, :compile] do
+  HTML::Proofer.new("./output").run
+end
+
 # Prompt user for a commit message; default: P U B L I S H :emoji:
 def commit_message
   publish_emojis = [':boom:', ':rocket:', ':metal:', ':bulb:', ':zap:',
diff --git a/changes/index.html b/changes/index.html
@@ -146,7 +146,7 @@ <h3 id="events">Events</h3>
 <h2 id="preview-period">Preview Period</h2>
 
 <p>We’re making this new API available today for developers to
-<a href="/v3/repos/deployments/#preview-mode">preview</a>.  We think developers and existing integrations are
+<a href="/v3/repos/deployments/#preview-mode" data-proofer-ignore>preview</a>.  We think developers and existing integrations are
 going to love it, but we want to <a href="https://github.com/contact?form%5Bsubject%5D=Deployments+API">get your feedback</a> before we declare
 the Deployments API “final” and “unchangeable.” We expect the preview period to
 last for roughly 60-90 days.</p>
diff --git a/content/changes/2012-10-17-org-members-redirection.md b/content/changes/2012-10-17-org-members-redirection.md
@@ -7,7 +7,7 @@ author_name: pezra
 
 Requesting the [member list](/v3/orgs/members/index.html#members-list) of an
 organization of which you are not a member now redirects to the [public members
-list](v3/orgs/members/index.html#public-members-list). Similarly, requests to
+list](/v3/orgs/members/index.html#public-members-list). Similarly, requests to
 [membership check](/v3/orgs/members/index.html#check-membership) resources of
 an organization of which you are not a member are redirected to the equivalent
 [public membership check](/v3/orgs/members/index.html#check-public-membership).
diff --git a/content/changes/2012-12-09-organization-repositories-results-now-paginate.html b/content/changes/2012-12-09-organization-repositories-results-now-paginate.html
@@ -5,7 +5,7 @@
 author_name: rick
 ---
 
-![](https://github-images.s3.amazonaws.com/skitch/seger-turn-the-page-20121209-154956.png)
+![seger-is-so-dreamy](https://github-images.s3.amazonaws.com/skitch/seger-turn-the-page-20121209-154956.png)
 
 Improvements continue to the Organizations Repository listing endpoint.
 Today we're improving pagination so that it works as documented.  Now
diff --git a/content/changes/2013-05-06-repository-stats.md b/content/changes/2013-05-06-repository-stats.md
@@ -11,10 +11,10 @@ but we can't wait to see what others can do with this information.
 
 Starting today, these resources are available to you:
 
-* **[Contributors](/v3/repos/statistics/#get-contributors-list-with-additions-deletions-and-commit-counts)**
-* **[Commit Activity](/v3/repos/statistics/#get-the-last-year-of-commit-activity-data)**
-* **[Code Frequency](/v3/repos/statistics/#get-the-number-of-additions-and-deletions-per-week)**
-* **[Participation](/v3/repos/statistics/#get-the-weekly-commit-count-for-the-repo-owner-and-everyone-else)**
-* **[Punch Card](/v3/repos/statistics/#get-the-number-of-commits-per-hour-in-each-day)**
+* **[Contributors](/v3/repos/statistics/#contributors)**
+* **[Commit Activity](/v3/repos/statistics/#commit-activity)**
+* **[Code Frequency](/v3/repos/statistics/#code-frequency)**
+* **[Participation](/v3/repos/statistics/#participation)**
+* **[Punch Card](/v3/repos/statistics/#punch-card)**
 
 Enjoy!
diff --git a/content/changes/2013-07-19-preview-the-new-search-api.md b/content/changes/2013-07-19-preview-the-new-search-api.md
@@ -31,7 +31,7 @@ numeric offsets identifying the exact location of each matching search term.
 ## Preview period
 
 We're making this new API available today for developers to
-[preview][preview-mode]. We think developers are going to love it, but we want
+<a href="/v3/search/#preview-mode" data-proofer-ignore>preview</a>. We think developers are going to love it, but we want
 to get your feedback before we declare the Search API "final" and
 "unchangeable." We expect the preview period to last for roughly 60 days.
 
@@ -63,7 +63,6 @@ We hope you'll kick the tires and [send us your feedback][contact]. Happy
 [issue-docs]: /v3/search/#search-issues
 [legacy-search]: /v3/search/legacy/
 [octokit-gemspecs]: /v3/search/#code-search-example
-[preview-mode]: /v3/search/#preview-mode
 [repo-docs]: /v3/search/#search-repositories
 [tetris-repos]: /v3/search/#repository-search-example
 [text-matches]: /v3/search#text-match-metadata
diff --git a/content/changes/2014-01-09-preview-the-new-deployments-api.md b/content/changes/2014-01-09-preview-the-new-deployments-api.md
@@ -59,7 +59,7 @@ whether or not to actually deploy the repository that the event was created for.
 ## Preview Period
 
 We're making this new API available today for developers to
-[preview][preview-mode].  We think developers and existing integrations are
+<a href="/v3/repos/deployments/#preview-mode" data-proofer-ignore>preview</a>.  We think developers and existing integrations are
 going to love it, but we want to [get your feedback][contact] before we declare
 the Deployments API "final" and "unchangeable." We expect the preview period to
 last for roughly 60-90 days.
@@ -75,10 +75,9 @@ stable and suitable for production use.
 
 We hope you’ll take it for a spin and [send us your feedback][contact].
 
-![](http://shipitsquirrel.github.io/images/ship%20it%20squirrel.png)
+![Shipit Squirrel](http://shipitsquirrel.github.io/images/ship%20it%20squirrel.png)
 
 [docs]: /v3/repos/deployments/
 [hooks]: /v3/repos/hooks/
-[preview-mode]: /v3/repos/deployments/#preview-mode
 [chatops]: https://speakerdeck.com/jnewland/chatops
 [contact]: https://github.com/contact?form[subject]=Deployments+API
diff --git a/content/guides/basics-of-authentication.md b/content/guides/basics-of-authentication.md
@@ -78,7 +78,7 @@ requesting `user:email` scope for reading private email addresses.
 
 Navigate your browser to `http://localhost:4567`. After clicking on the link, you
 should be taken to GitHub, and presented with a dialog that looks something like this:
-![](/images/oauth_prompt.png)
+![GitHub's OAuth Prompt](/images/oauth_prompt.png)
 
 If you trust yourself, click **Authorize App**. Wuh-oh! Sinatra spits out a
 `404` error. What gives?!
diff --git a/content/guides/getting-started.md b/content/guides/getting-started.md
@@ -184,13 +184,13 @@ indicating the name of the app, as well as the level of access the app
 has once it's authorized by the user. After a user authorizes access, GitHub
 redirects the user back to the application:
 
-![](/images/oauth_prompt.png)
+![GitHub's OAuth Prompt](/images/oauth_prompt.png)
 
 However, you don't need to set up the entire web flow to begin working with OAuth tokens.
 An easier way to get a token is to [create a **Personal token**][personal token] via your
 [Application settings page][application settings]:
 
-![](/images/personal_token.png)
+![Personal Token selection](/images/personal_token.png)
 
 Also, the [**Authorizations API**][authorizations api] makes it simple to use Basic Authentication
 to create an OAuth token. Try pasting and running the following command:
@@ -541,7 +541,7 @@ Keep learning with the next API guide [Basics of Authentication][auth guide]!
 [pagination]: /v3/#pagination
 [get repo]: /v3/repos/#get
 [create repo]: /v3/repos/#create
-[create issue]: /v3/issues/#create
+[create issue]: /v3/issues/#create-an-issue
 [auth guide]: /guides/basics-of-authentication
 [user repos api]: /v3/repos/#list-your-repositories
 [other user repos api]: /v3/repos/#list-user-repositories
diff --git a/content/guides/index.md b/content/guides/index.md
@@ -15,4 +15,4 @@ stored and documented in our public
 
 Feel free to fork, clone, and improve these guides.
 
-![](/images/professorcat.png)
+![The Professorcat](/images/professorcat.png)
diff --git a/content/index.md b/content/index.md
@@ -8,7 +8,7 @@ layout: overview
 GitHub in your app</h1>
 	<p class="intro">Get started with one of our guides, or jump straight into the API documentation.</p>
 	<a href="/v3/" class="button">Browse the documentation</a>
-	<img src="/shared/images/labtocat.png" class="labtocat" />
+	<img src="/shared/images/labtocat.png" class="labtocat" alt="The Labtocat" />
 </div>
 
 <div class="full-width-divider">
@@ -28,6 +28,6 @@ GitHub in your app</h1>
 			<h2><a href="http://github.com/contact">Support</a></h2>
 			<p>Are you stuck? Already tried our <a href="/v3/troubleshooting/">troubleshooting guide</a>? Talk to a supportocat.</p>
 		</li>
-		
+
 	</ul>
 </div>
diff --git a/content/libraries.md b/content/libraries.md
@@ -12,7 +12,7 @@ many flavors</h1>
 		<li><span>Obj-C</span><a href="https://github.com/octokit/octokit.objc">octokit.objc</a></li>
 		<li><span>.NET</span><a href="https://github.com/octokit/octokit.net">octokit.net</a></li>
 	</ul>
-	<img src="/shared/images/gundamcat.png" class="gundamcat" />
+	<img src="/shared/images/gundamcat.png" class="gundamcat" alt="The Gundamcat" />
 </div>
 
 # Third-party libraries
diff --git a/content/v3/rate_limit.md b/content/v3/rate_limit.md
@@ -37,7 +37,7 @@ The Search API has a [custom rate limit](/v3/search/#rate-limit), separate from
 the rate limit governing the rest of the API. For that reason, the response
 (shown above) categorizes your rate limit by resource. Within the `"resources"`
 hash, the `"search"` hash provides your rate limit status for the
-[Search API](v3/search). The `"core"` hash provides your rate limit status for
+[Search API](/v3/search). The `"core"` hash provides your rate limit status for
 all the _rest_ of the API.
 
 #### Deprecation Notice
diff --git a/content/v3/repos/statistics.md b/content/v3/repos/statistics.md
@@ -41,7 +41,7 @@ which is usually master; pushing to the default branch resets the statistics cac
 * `c` - Number of commits
 
 
-## Get the last year of commit activity data
+## Get the last year of commit activity data {#commit-activity}
 
 Returns the last year of commit activity grouped by week.  The `days` array
 is a group of commits per day, starting on `Sunday`.
diff --git a/index.html b/index.html
@@ -42,7 +42,7 @@ <h1>Leverage the power of<br>
 GitHub in your app</h1>
 	<p class="intro">Get started with one of our guides, or jump straight into the API documentation.</p>
 	<a href="/v3/" class="button">Browse the documentation</a>
-	<img src="/shared/images/labtocat.png" class="labtocat">
+	<imgsrc="/shared/images/labtocat.png" class="labtocat" alt="The Labtocat">
 </div>
 
 <div class="full-width-divider">
diff --git a/layouts/header.html b/layouts/header.html
@@ -3,7 +3,6 @@
     <div>
       <a class="logo" href="/">GitHub:Developer</a>
       <ul class="nav">
-        <li><a href="/" class="nav-overview">Overview</a></li>
         <li><a href="/v3/" class="nav-api">API</a></li>
         <li><a href="/changes/" class="nav-blog">Blog</a></li>
         <li><a href="https://github.com/contact">Support</a></li>
diff --git a/layouts/sidebar.html b/layouts/sidebar.html
@@ -2,7 +2,7 @@
   <div class="js-toggle-list sidebar-module expandable">
     <ul>
       <li class="js-topic">
-        <h3><a href="#" class="js-expand-btn collapsed arrow-btn"></a><a href="/v3/">Overview</a></h3>
+        <h3><a href="#" class="js-expand-btn collapsed arrow-btn" data-proofer-ignore></a><a href="/v3/">Overview</a></h3>
         <ul class="js-guides">
           <li><a href="/v3/media/">Media Types</a></li>
           <li><a href="/v3/oauth/">OAuth</a></li>
@@ -12,7 +12,7 @@ <h3><a href="#" class="js-expand-btn collapsed arrow-btn"></a><a href="/v3/">Ove
         </ul>
       </li>
       <li class="js-topic">
-        <h3><a href="#" class="js-expand-btn collapsed arrow-btn"></a><a href="/v3/activity/">Activity</a></h3>
+        <h3><a href="#" class="js-expand-btn collapsed arrow-btn" data-proofer-ignore></a><a href="/v3/activity/">Activity</a></h3>
         <ul class="js-guides">
           <li><a href="/v3/activity/events/">Events</a></li>
           <li><a href="/v3/activity/events/types/">Event Types</a></li>
@@ -23,13 +23,13 @@ <h3><a href="#" class="js-expand-btn collapsed arrow-btn"></a><a href="/v3/activ
         </ul>
       </li>
       <li class="js-topic">
-        <h3><a href="#" class="js-expand-btn collapsed arrow-btn"></a><a href="/v3/gists/">Gists</a></h3>
+        <h3><a href="#" class="js-expand-btn collapsed arrow-btn" data-proofer-ignore></a><a href="/v3/gists/">Gists</a></h3>
         <ul class="js-guides">
           <li><a href="/v3/gists/comments/">Comments</a></li>
         </ul>
       </li>
       <li class="js-topic">
-        <h3><a href="#" class="js-expand-btn collapsed arrow-btn"></a><a href="/v3/git/">Git Data</a></h3>
+        <h3><a href="#" class="js-expand-btn collapsed arrow-btn" data-proofer-ignore></a><a href="/v3/git/">Git Data</a></h3>
         <ul class="js-guides">
           <li><a href="/v3/git/blobs/">Blobs</a></li>
           <li><a href="/v3/git/commits/">Commits</a></li>
@@ -39,7 +39,7 @@ <h3><a href="#" class="js-expand-btn collapsed arrow-btn"></a><a href="/v3/git/"
         </ul>
       </li>
       <li class="js-topic">
-        <h3><a href="#" class="js-expand-btn collapsed arrow-btn"></a><a href="/v3/issues/">Issues</a></h3>
+        <h3><a href="#" class="js-expand-btn collapsed arrow-btn" data-proofer-ignore></a><a href="/v3/issues/">Issues</a></h3>
         <ul class="js-guides">
           <li><a href="/v3/issues/assignees/">Assignees</a></li>
           <li><a href="/v3/issues/comments/">Comments</a></li>
@@ -49,7 +49,7 @@ <h3><a href="#" class="js-expand-btn collapsed arrow-btn"></a><a href="/v3/issue
         </ul>
       </li>
       <li class="js-topic">
-        <h3><a href="#" class="js-expand-btn collapsed arrow-btn"></a><a href="/v3/misc/">Miscellaneous</a></h3>
+        <h3><a href="#" class="js-expand-btn collapsed arrow-btn" data-proofer-ignore></a><a href="/v3/misc/">Miscellaneous</a></h3>
         <ul class="js-guides">
           <li><a href="/v3/emojis/">Emojis</a></li>
           <li><a href="/v3/gitignore/">Gitignore</a></li>
@@ -59,20 +59,20 @@ <h3><a href="#" class="js-expand-btn collapsed arrow-btn"></a><a href="/v3/misc/
         </ul>
       </li>
       <li class="js-topic">
-        <h3><a href="#" class="js-expand-btn collapsed arrow-btn"></a><a href="/v3/orgs/">Organizations</a></h3>
+        <h3><a href="#" class="js-expand-btn collapsed arrow-btn" data-proofer-ignore></a><a href="/v3/orgs/">Organizations</a></h3>
         <ul class="js-guides">
           <li><a href="/v3/orgs/members/">Members</a></li>
           <li><a href="/v3/orgs/teams/">Teams</a></li>
         </ul>
       </li>
       <li class="js-topic">
-        <h3><a href="#" class="js-expand-btn collapsed arrow-btn"></a><a href="/v3/pulls/">Pull Requests</a></h3>
+        <h3><a href="#" class="js-expand-btn collapsed arrow-btn" data-proofer-ignore></a><a href="/v3/pulls/">Pull Requests</a></h3>
         <ul class="js-guides">
           <li><a href="/v3/pulls/comments/">Review Comments</a></li>
         </ul>
       </li>
       <li class="js-topic">
-        <h3><a href="#" class="js-expand-btn collapsed arrow-btn"></a><a href="/v3/repos/">Repositories</a></h3>
+        <h3><a href="#" class="js-expand-btn collapsed arrow-btn" data-proofer-ignore></a><a href="/v3/repos/">Repositories</a></h3>
         <ul class="js-guides">
           <li><a href="/v3/repos/collaborators/">Collaborators</a></li>
           <li><a href="/v3/repos/comments/">Comments</a></li>
@@ -90,7 +90,7 @@ <h3><a href="#" class="js-expand-btn collapsed arrow-btn"></a><a href="/v3/repos
         </ul>
       </li>
       <li class="js-topic">
-        <h3><a href="#" class="js-expand-btn collapsed arrow-btn"></a><a href="/v3/search/">Search</a></h3>
+        <h3><a href="#" class="js-expand-btn collapsed arrow-btn" data-proofer-ignore></a><a href="/v3/search/">Search</a></h3>
         <ul class="js-guides">
           <li><a href="/v3/search/#search-repositories">Repositories</a></li>
           <li><a href="/v3/search/#search-code">Code</a></li>
@@ -100,7 +100,7 @@ <h3><a href="#" class="js-expand-btn collapsed arrow-btn"></a><a href="/v3/searc
         </ul>
       </li>
       <li class="js-topic">
-        <h3><a href="#" class="js-expand-btn collapsed arrow-btn"></a><a href="/v3/users/">Users</a></h3>
+        <h3><a href="#" class="js-expand-btn collapsed arrow-btn" data-proofer-ignore></a><a href="/v3/users/">Users</a></h3>
         <ul class="js-guides">
           <li><a href="/v3/users/emails/">Emails</a></li>
           <li><a href="/v3/users/followers/">Followers</a></li>
diff --git a/lib/resources.rb b/lib/resources.rb
diff --git a/libraries/index.html b/libraries/index.html
diff --git a/script/bootstrap b/script/bootstrap
diff --git a/script/cibuild b/script/cibuild

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+language: ruby`
	`2`	`+rvm:`
	`3`	`+ - 1.9.3`