wayfarer 0.0.3

data/docs/_includes/navigation.html

@@ -0,0 +1,187 @@
+<section class="navigation">
+  <input id="navigation__toggle-checkbox" class="navigation__toggle-checkbox" type="checkbox">
+  <label for="navigation__toggle-checkbox" class="navigation__toggle-label">
+    <span class="show">Show navigation</span>
+    <span class="hide">Hide navigation</span>
+  </label>
+  <nav class="navigation__main">
+    <ul class="navigation__list">
+      <li class="navigation__category">
+        <h1 class="navigation__category__title">Guides</h1>
+        <ul class="navigation__list">
+          <li class="navigation__page">
+            <a class="navigation__link" href="{{base}}/guides/tutorial.html">
+              Tutorial
+            </a>
+          </li>
+          <li class="navigation__page">
+            <a class="navigation__link" href="{{base}}/guides/configuration.html">
+              Configuration
+            </a>
+          </li>
+          <li class="navigation__page">
+            <a class="navigation__link" href="{{base}}/guides/halting.html">
+              Halting
+            </a>
+          </li>
+          <li class="navigation__page">
+            <a class="navigation__link" href="{{base}}/guides/locals.html">
+              Locals
+            </a>
+          </li>
+          <li class="navigation__page">
+            <a class="navigation__link" href="{{base}}/guides/page_objects.html">
+              <code>Page</code> objects
+            </a>
+          </li>
+          <li class="navigation__page">
+            <a class="navigation__link" href="{{base}}/guides/error_handling.html">
+              Error handling
+            </a>
+          </li>
+          <li class="navigation__page">
+            <a class="navigation__link" href="{{base}}/guides/frontiers.html">
+              (Redis) Frontiers
+            </a>
+          </li>
+          <li class="navigation__page">
+            <a class="navigation__link" href="{{base}}/guides/peeking.html">
+              Peeking
+            </a>
+          </li>
+          <li class="navigation__page">
+            <a class="navigation__link" href="{{base}}/guides/selenium_capybara.html">
+              Selenium &amp; Capybara
+            </a>
+          </li>
+          <li class="navigation__page">
+            <a class="navigation__link" href="{{base}}/guides/callbacks.html">
+              Callbacks
+            </a>
+          </li>
+          <li class="navigation__page">
+            <a class="navigation__link" href="{{base}}/guides/cli.html">
+              CLI
+            </a>
+          </li>
+          <li class="navigation__page">
+            <a class="navigation__link" href="{{base}}/guides/job_queues.html">
+              Job queues
+            </a>
+          </li>
+          <li class="navigation__page">
+            <a class="navigation__link" href="{{base}}/guides/logging.html">
+              Logging
+            </a>
+          </li>
+        </ul>
+      </li>
+
+      <li class="navigation__category">
+        <h1 class="navigation__category__title">Routing</h1>
+        <ul class="navigation__list">
+          <li class="navigation__page">
+            <a class="navigation__link" href="{{base}}/routing/routes.html">
+              Routes
+            </a>
+          </li>
+          <li class="navigation__page">
+            <a class="navigation__link" href="{{base}}/routing/uri_rules.html">
+              URI rules
+            </a>
+          </li>
+          <li class="navigation__page">
+            <a class="navigation__link" href="{{base}}/routing/host_rules.html">
+              Host rules
+            </a>
+          </li>
+          <li class="navigation__page">
+            <a class="navigation__link" href="{{base}}/routing/path_rules.html">
+              Path rules
+            </a>
+          </li>
+          <li class="navigation__page">
+            <a class="navigation__link" href="{{base}}/routing/query_rules.html">
+              Query rules
+            </a>
+          </li>
+          <li class="navigation__page">
+            <a class="navigation__link" href="{{base}}/routing/protocol_rules.html">
+              Protocol rules
+            </a>
+          </li>
+          <li class="navigation__page">
+            <a class="navigation__link" href="{{base}}/routing/filetypes_rules.html">
+              Filetypes rules
+            </a>
+          </li>
+          <li class="navigation__page">
+            <a class="navigation__link" href="{{base}}/routing/custom_rules.html">
+              Custom rules
+            </a>
+          </li>
+        </ul>
+      </li>
+
+      <li class="navigation__category">
+        <h1 class="navigation__category__title">Recipes</h1>
+        <ul class="navigation__list">
+          <li class="navigation__page">
+            <a class="navigation__link" href="{{base}}/recipes/multiple_uris.html">
+              Starting from multiple URIs
+            </a>
+          </li>
+          <li class="navigation__page">
+            <a class="navigation__link" href="{{base}}/recipes/authentication.html">
+              Authentication
+            </a>
+          </li>
+          <li class="navigation__page">
+            <a class="navigation__link" href="{{base}}/recipes/screenshots.html">
+              Taking screenshots
+            </a>
+          </li>
+          <li class="navigation__page">
+            <a class="navigation__link" href="{{base}}/recipes/javascript.html">
+              Executing JavaScript
+            </a>
+          </li>
+          <li class="navigation__page">
+            <a class="navigation__link" href="{{base}}/recipes/csv.html">
+              CSV output
+            </a>
+          </li>
+        </ul>
+      </li>
+
+      <li class="navigation__category">
+        <h1 class="navigation__category__title">Miscellaneous</h1>
+        <ul class="navigation__list">
+          <li class="navigation__page">
+            <a class="navigation__link" href="//github.com/bauerd/wayfarer">
+              Code on GitHub
+            </a>
+          </li>
+          <li class="navigation__page">
+            <a class="navigation__link" href="http://www.rubydoc.info/github/bauerd/wayfarer">
+              API documentation
+            </a>
+          </li>
+          <li class="navigation__page">
+            <a class="navigation__link" href="{{base}}/misc/testing.html">
+              Testing
+            </a>
+          </li>
+          <li class="navigation__page">
+            <a class="navigation__link" href="{{base}}/misc/contributing.html">
+              Contributing
+            </a>
+          </li>
+        </ul>
+      </li>
+
+    <label for="navigation__toggle-checkbox" class="navigation__close-bottom">
+      Hide navigation
+    </label>
+  </nav>
+</section>

data/docs/_layouts/default.html

@@ -0,0 +1,42 @@
+<!DOCTYPE html>
+<html lang="en">
+  {% include base.html %}
+  {% include head.html %}
+
+  <body>
+    <div class="wrapper">
+      <aside class="sidebar">
+        <header class="site-header">
+          <h1 class="site-header__title">
+            <a href="{{base}}" class="site-header__link">{{ site.title }}</a>
+          </h1>
+          <div class="site-header__version">
+            0.0.3
+          </div>
+        </header>
+
+        <section class="badges">
+          <iframe class="star-button" src="https://ghbtns.com/github-btn.html?user=bauerd&repo=wayfarer&type=star" frameborder="0" scrolling="0" width="50px" height="20px"></iframe>
+          <img class="build-status" src="https://travis-ci.org/bauerd/wayfarer.svg?branch=master">
+        </section>
+
+        {% include navigation.html %}
+      </aside>
+
+      <main class="page-content">
+        {{content}}
+
+        <aside class="page-meta">
+          Instructions unclear or not working? Please
+          <a href="{{site.github.repository_url}}/edit/master/docs/{{page.path}}">
+            edit this page
+          </a>
+          or
+          <a href="{{site.github.repository_url}}/issues/new">
+            file a bug
+          </a>
+        </aside>
+      </main>
+    </div>
+  </body>
+</html>

data/docs/_sass/base.scss

@@ -0,0 +1,439 @@
+@import "vendor/normalize-3.0.2";
+@import "vendor/pygments";
+@import "vendor/bourbon/bourbon";
+@import "vendor/neat/neat";
+
+*:focus,
+*:focus:hover {
+  outline: rem(1) dotted $mikado;
+  background: rgba($mikado, 0.05);
+}
+
+html {
+  @include media($mobile) {
+    font-size: 87.5%;
+  }
+
+  @include media(min-width 560px) {
+    font-size: 112.5%;
+  }
+
+  @include media($desktop) {
+    font-size: 100%;
+  }
+}
+
+body {
+  font: {
+    family: "Titillium", sans-serif;
+    size: rem($fs);
+  }
+  line-height: $rlh;
+  -webkit-font-smoothing: antialiased;
+
+  background: $mine-shaft;
+  color: $mine-shaft;
+
+  -webkit-tap-highlight-color: rgba($emerald, 0.8);
+}
+
+h1, h2, h3, h4, h5, h6 {
+  margin-bottom: rem($alh);
+  font-weight: normal;
+  color: tint($mine-shaft, 10%);
+}
+
+h3, h4, h5, h6 {
+  margin-bottom: rem($alh * 0.5);
+}
+
+h1 {
+  font-size: rem(32);
+  line-height: rem($alh * 1.5);
+}
+
+h2 {
+  font-size: rem(26);
+  line-height: rem($alh);
+}
+
+h3 {
+  font-size: rem(20);
+  line-height: rem($alh);
+}
+
+h4 {
+  font-size: rem(18);
+  line-height: rem($alh);
+}
+
+h5, h6 {
+  font: inherit;
+}
+
+ul, ol, p {
+  margin: rem($alh * 0.5) 0;
+}
+
+ul, ol {
+  padding-left: rem($alh * 0.7);
+}
+
+hr {
+  border: 0;
+  height: rem(1);
+  margin: rem($alh) 0;
+  background: tint($mine-shaft, 95%);
+}
+
+a {
+  color: $blue;
+  text-decoration: none;
+
+  &:hover {
+    color: $amaranth;
+  }
+}
+
+code {
+  font-family: "Roboto Mono", monospace;
+  font-size: 0.95em;
+  letter-spacing: rem(-0.5);
+}
+
+pre {
+  margin: 0;
+}
+
+table {
+  width: 100%;
+  margin-bottom: rem(24);
+}
+
+th {
+  font-weight: bold;
+  background-color: tint($mine-shaft, 95%);
+}
+
+th, td {
+  text-align: left;
+  padding: rem(4) rem(10);
+  border-bottom: rem(1) solid tint($mine-shaft, 85%);
+}
+
+@include selection {
+  background: rgba($mikado, 0.6);
+}
+
+.note {
+  margin: rem($alh * 0.5) 0;
+  padding: rem($alh * 0.35) rem($alh * 0.5);
+
+  background-color: tint($mikado, 90%);
+  color: shade($mikado, 75%);
+
+  font-size: rem(14);
+
+  &:before {
+    content: "Note";
+    display: inline-block;
+    margin-right: 0.25em;
+    padding: rem(4) rem(4) rem(2) rem(4);
+    border-radius: rem(2);
+
+    background: $mikado;
+
+    font: {
+      size: rem(12);
+      weight: bold;
+    }
+    text-transform: uppercase;
+    letter-spacing: rem(0.5);
+    line-height: 1;
+  }
+}
+
+.highlight {
+  margin: rem($alh * 0.75) 0;
+
+  border-radius: rem(4);
+  border: rem(1) solid rgba($mine-shaft, 0.1);
+  border-top-color:rgba($mine-shaft, 0.05);
+  border-bottom-color:rgba($mine-shaft, 0.15);
+
+  // background-color: tint($mine-shaft, 98%);
+  font-size: rem(14);
+  line-height: 1.8;
+
+  pre,
+  code {
+    display: block;
+    padding: rem($alh * 0.25) rem($alh * 0.5);
+  }
+
+  pre code {
+    padding: 0;
+  }
+}
+
+
+.illustration {
+  margin-bottom: rem($alh * 0.5);
+  font-size: rem(14);
+  line-height: 1.1;
+}
+
+.wrapper {
+  @include outer-container;
+  max-width: rem(1080);
+  margin: 0 auto;
+}
+
+.sidebar {
+  color: white;
+
+  @include media($desktop) {
+    @include span-columns(4);
+    padding-top: rem($alh);
+  }
+
+  @include media($mobile) {
+    @include span-columns(16);
+    padding-top: rem($alh * 0.5);
+    text-align: center;
+  }
+}
+
+.site-header {
+  margin-bottom: rem($alh * 0.5);
+}
+
+.site-header__title {
+  display: inline-block;
+  font: {
+    size: rem(24);
+    weight: bold;
+  }
+  margin-bottom: 0;
+  margin-right: rem($alh * 0.5);
+  line-height: 1.2;
+  text-decoration: uppercase;
+  line-height: rem($alh);
+}
+
+.site-header__link {
+  color: white;
+  text-decoration: none;
+
+  &:hover {
+    color: rgba(white, 0.8);
+  }
+}
+
+.site-header__version {
+  color: tint($mine-shaft, 60%);
+}
+
+.badges {
+  @include clearfix;
+
+  height: rem(20);
+  margin-bottom: rem($alh);
+
+  @include media($mobile) {
+    display: inline-block;
+    margin: 0 auto;
+    margin-bottom: rem($alh * 0.5);
+  }
+}
+
+.star-button,
+.build-status {
+  display: inline-block;
+  float: left;
+}
+
+.star-button {
+  margin-right: rem($alh * 0.25);
+}
+
+.page-content {
+  @include media($mobile) {
+    @include span-columns(16);
+    padding: rem($alh * 0.5) rem($alh);
+  }
+
+  @include media($desktop) {
+    @include span-columns(12);
+    min-height: 100vh;
+    padding: 1em 3em;
+  }
+
+  background: white;
+
+  h1, h2 {
+    padding-bottom: rem($alh * 0.25);
+    border-bottom: 1px solid tint($mine-shaft, 90%);
+
+    &:not(:first-child) {
+      margin-top: rem($alh * 2);
+    }
+  }
+}
+
+.navigation__list {
+  margin: 0 0 rem($alh) 0;
+  padding: 0;
+  list-style: none;
+}
+
+@include media($mobile) {
+  .navigation {
+    @include clearfix;
+  }
+
+  .navigation__toggle-checkbox,
+  .navigation__toggle-label,
+  .navigation__main {
+    display: block;
+    float: left;
+    width: 100%;
+  }
+
+  .navigation__toggle-checkbox {
+    @include appearance(none);
+  }
+
+  .navigation__toggle-label {
+    display: block;
+    padding: rem($alh * 0.5) rem($alh * 0.25);
+
+    background: rgba(white, 0.05);
+
+    cursor: pointer;
+
+    &:hover {
+      background: rgba(white, 0.1);
+    }
+  }
+
+  .navigation__toggle-checkbox ~ .navigation__toggle-label {
+    .show {
+      display: block;
+    }
+
+    .hide {
+      display: none;
+    }
+  }
+
+  .navigation__toggle-checkbox:checked ~ .navigation__toggle-label {
+    background: $amaranth;
+
+    &:hover {
+      background: rgba($amaranth, 0.9);
+    }
+
+    .show {
+      display: none;
+    }
+
+    .hide {
+      display: block;
+    }
+  }
+
+  .navigation__toggle-checkbox ~ .navigation__main {
+    display: none;
+  }
+
+  .navigation__toggle-checkbox:checked ~ .navigation__main {
+    display: block;
+  }
+
+  .navigation__main {
+    background: white;
+  }
+
+  .navigation__category__title {
+    margin-bottom: rem($alh * 0.25);
+    font-size: rem(14);
+    text-transform: uppercase;
+    letter-spacing: rem(2);
+  }
+
+  .navigation__link {
+    display: block;
+    margin-bottom: 1px;
+    padding: rem($alh * 0.25);
+    padding-top: rem($alh * 0.4);
+
+    background-color: tint($mine-shaft, 95%);
+
+    &:hover {
+      background-color: $mikado;
+      color: $mine-shaft;
+    }
+  }
+
+  .navigation__close-bottom {
+    font-size: rem(14);
+    display: inline-block;
+    color: $amaranth;
+    border: 1px solid $amaranth;
+    border-radius: 1em;
+    padding: rem(2) rem($alh * 0.5) 0 rem($alh  * 0.5);
+    cursor: pointer;
+
+    &:hover {
+      background: $amaranth;
+      color: white;
+    }
+  }
+}
+
+@include media($desktop) {
+  .navigation__toggle-checkbox,
+  .navigation__toggle-label,
+  .navigation__close-bottom {
+    display: none;
+  }
+
+  .navigation__list {
+    margin: 0 0 rem($alh) 0;
+    padding: 0;
+  }
+
+  .navigation__category__title {
+    margin-bottom: rem($alh * 0.25);
+    font-size: rem(14);
+    line-height: inherit;
+    color: tint($mine-shaft, 45%);
+  }
+
+  .navigation__link {
+    display: block;
+    font-size: rem(16);
+    color: $emerald;
+
+    &:hover {
+      color: $mikado;
+      font-weight: bold;
+    }
+  }
+
+  .navigation__link.navigation__link--active {
+    font-weight: bold;
+    color: white;
+    cursor: default;
+    pointer-events: none;
+  }
+}
+
+.page-meta {
+  font-size: rem(16);
+  margin: rem(24) 0 rem(16) 0;
+  padding-top: rem(24);
+  border-top: 1px solid tint($mine-shaft, 90%);
+  color: tint($mine-shaft, 40%);
+}

data/docs/_sass/variables.scss

@@ -0,0 +1,24 @@
+// Grid
+$max-width: 1080px;
+$grid-columns: 16;
+
+// Breakpoints
+$desktop: min-width 1180px;
+$mobile:  max-width 1179px;
+
+// Typography
+$fs: 18;
+$rlh: 1.6;
+$alh: $fs * $rlh;
+
+// Colours
+$mine-shaft: #333333;
+$blue: #4F67FF;
+$amaranth: #E93C4F;
+$emerald: #18CDCA;
+$mikado: #FFDE20;
+
+// These are used in the Pygments theme
+// #333333
+// #2F3661 (literals)
+// #727273 (Comments)

data/docs/_sass/vendor/bourbon/_bourbon-deprecate.scss

@@ -0,0 +1,19 @@
+@charset "UTF-8";
+
+/// Throws Sass warnings to announce library deprecations. You can disable them
+/// by setting the `$output-bourbon-deprecation-warnings` variable to `false`.
+///
+/// @access private
+
+@mixin _bourbon-deprecate($feature, $message: null) {
+  @if $output-bourbon-deprecation-warnings == true {
+    @warn "[Bourbon] [Deprecation] `#{$feature}` is deprecated and will be " +
+      "removed in 5.0.0. #{$message}";
+    @content;
+  }
+}
+
+@mixin _bourbon-deprecate-for-prefixing($feature) {
+  @include _bourbon-deprecate($feature, "We suggest using an automated " +
+    "prefixing tool, like Autoprefixer.");
+}