just-the-docs 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7fc20c9068d28991177f8ccd3ec04747fdd54c74
-  data.tar.gz: 5be60769fac00a2d25de8eea1c770af1571efa89
+  metadata.gz: 34c636bb5dad48e01e8b114762877acac6ab188f
+  data.tar.gz: 8d294505dc73afb5b4eb13f5c4e3f82e89c0cb36
 SHA512:
-  metadata.gz: e5d92dd04257dc95977d62e4c104a7c62594e8c71422a159f76108582e21886baebf40f1f1beb8b804e2eb7ee7d6b9b852a77e81421ecbfd898b5d9e1689c82e
-  data.tar.gz: d62198fada4fd7988680e754c0ff1546e3be82d9dbd448aec9538255305fe7e0a1bf713950350ccacd85240a969957b8c4085f6fabe881a242dc1b2555e4efcd
+  metadata.gz: eb73494f49b1bda8c851921560adf353b8173c21af5b858e03f8a9e5f4d20bb85f241a3dc8aff5159df590372109aef97cf2467fb8a3d77a39b8646ddffe8b0c
+  data.tar.gz: d358b60858410d90a86515f3d734fe7897f7268ff24dc64c85e3c2800fd21abff86f545282068c1e1ca2e5a6a322aa5b38d3c363d5986c1e97d99e7847135b66

data/README.md

@@ -28,7 +28,7 @@ Or install it yourself as:
 
 ## Usage
 
-View the documentation for more information.
+[View the documentation](https://pmarsceill.github.io/just-the-docs/) for usage information.
 
 ## Contributing
 
@@ -40,7 +40,16 @@ To set up your environment to develop this theme, run `bundle install`.
 
 Your theme is setup just like a normal Jekyll site! To test your theme, run `bundle exec jekyll serve` and open your browser at `http://localhost:4000`. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.
 
-When your theme is released, only the files in `_layouts`, `_includes`, and `_sass` tracked with Git will be released.
+When the theme is released, only the files in `_layouts`, `_includes`, and `_sass` tracked with Git will be released.
+
+
+### When your changes are ready:
+
+- Open a [Pull Request](https://github.com/pmarsceill/just-the-docs/pulls)
+- Await code review
+- Bump the version number in `just-the-docs.gemspec`
+- Run `script/build` to package the gem
+- Run `gem push just-the-docs-<version>.gem` to publish the gem to Rubygems.org
 
 ## License
 

data/_includes/head.html

@@ -3,9 +3,9 @@
   <meta http-equiv="X-UA-Compatible" content="IE=Edge">
 
   <title>{{ page.title }} - {{ site.title }}</title>
-  <link rel="stylesheet" href="/assets/css/just-the-docs.css">
-  <script type="text/javascript" src="/assets/js/vendor/lunr.min.js"></script>
-  <script type="text/javascript" src="/assets/js/just-the-docs.js"></script>
+  <link rel="stylesheet" href="{{ "/assets/css/just-the-docs.css" | absolute_url }}">
+  <script type="text/javascript" src="{{ "/assets/js/vendor/lunr.min.js" | absolute_url }}"></script>
+  <script type="text/javascript" src="{{ "/assets/js/just-the-docs.js" | absolute_url }}"></script>
 
   <meta name="viewport" content="width=device-width, initial-scale=1">
 </head>

data/_layouts/default.html

@@ -9,15 +9,15 @@
       <span class="fs-3"><button class="js-main-nav-trigger navigation-list-toggle btn btn-outline" type="button" data-text-toggle="Hide">Menu</button></span>
       <div class="navigation main-nav js-main-nav">
         {% include nav.html %}
-        <footer role="contentinfo" class="site-footer">
-          <p class="text-small text-grey-dk-000 mb-0">This site uses <a href="https://github.com/pmarsceill/just-the-docs">Just the Docs</a>, a documentation theme for Jekyll.</p>
-        </footer>
       </div>
+      <footer role="contentinfo" class="site-footer">
+        <p class="text-small text-grey-dk-000 mb-0">This site uses <a href="https://github.com/pmarsceill/just-the-docs">Just the Docs</a>, a documentation theme for Jekyll.</p>
+      </footer>
     </div>
     <div class="main-content-wrap">
       <div class="page-header">
         <div class="main-content pb-0">
-          <div class="search">
+          <div class="search js-search">
             <div class="search-input-wrap">
               <input type="text" class="js-search-input search-input fs-2" placeholder="Search {{ site.title }}" aria-label="Search {{ site.title }}" autocomplete="off">
               <svg width="14" height="14" viewBox="0 0 28 28" xmlns="http://www.w3.org/2000/svg" class="search-icon"><title>Search</title><g fill-rule="nonzero"><path d="M17.332 20.735c-5.537 0-10-4.6-10-10.247 0-5.646 4.463-10.247 10-10.247 5.536 0 10 4.601 10 10.247s-4.464 10.247-10 10.247zm0-4c3.3 0 6-2.783 6-6.247 0-3.463-2.7-6.247-6-6.247s-6 2.784-6 6.247c0 3.464 2.7 6.247 6 6.247z"/><path d="M11.672 13.791L.192 25.271 3.02 28.1 14.5 16.62z"/></g></svg>

data/_sass/content.scss

@@ -57,8 +57,11 @@
     }
   }
 
-  hr + *,
-  h1:first-of-type {
+  hr + * {
     margin-top: 0;
   }
+
+  h1:first-of-type {
+    margin-top: 0.5em;
+  }
 }

data/_sass/labels.scss

@@ -14,6 +14,7 @@
   color: $white;
   vertical-align: middle;
   background-color: $blue-100;
+  text-transform: uppercase;
   @include fs-2;
 }
 

data/_sass/layout.scss

@@ -93,7 +93,8 @@
 }
 
 .navigation,
-.site-title {
+.site-title,
+.site-footer {
 
   @include container;
 
@@ -114,8 +115,21 @@
   }
 }
 
+body {
+  position: relative;
+  padding-bottom: $sp-10;
+
+  @include mq(md) {
+    position: static;
+    padding-bottom: 0;
+  }
+}
+
 .site-footer {
+  position: absolute;
+  bottom: $sp-3;
+
   @include mq(md) {
-    margin-top: $sp-10;
+    right: 0;
   }
 }

data/_sass/navigation.scss

@@ -20,6 +20,7 @@
 .navigation-list {
   padding: 0;
   margin-top: $sp-4;
+  margin-bottom: 0;
   list-style: none;
 
   @include mq(md) {
@@ -53,8 +54,12 @@
 }
 
 .navigation-list-item {
-  @include fs-3;
+  @include fs-4;
   margin: 0;
+
+  @include mq(md) {
+    @include fs-3;
+  }
 }
 
 .navigation-list-link {

data/_sass/search.scss

@@ -3,15 +3,27 @@
 //
 
 .search {
+  position: relative;
+  z-index: 99;
   display: none;
+  flex-grow: 1;
+  padding-bottom: $gutter-spacing / 2;
+  background-color: $white;
+  padding: $sp-2;
+  margin-bottom: $sp-3;
 
   @include mq(md) {
-    position: relative;
-    z-index: 99;
     display: block;
-    flex-grow: 1;
     padding-top: $sp-1;
-    padding-bottom: $gutter-spacing / 2;
+    padding-right: 0;
+    padding-bottom: $sp-4;
+    padding-left: 0;
+    margin-bottom: 0;
+    background-color: transparent;
+  }
+
+  &.nav-open {
+    display: block;
   }
 }
 

data/_sass/typography.scss

@@ -50,5 +50,9 @@ li {
 }
 
 .text-mono {
-  font-family: $mono-font-family;
+  font-family: $mono-font-family !important;
+}
+
+.text-center {
+  text-align: center !important;
 }

data/assets/js/just-the-docs.js

@@ -13,6 +13,7 @@ function toggleNav(){
   const nav = document.querySelector('.js-main-nav');
   const auxNav = document.querySelector('.js-aux-nav');
   const navTrigger = document.querySelector('.js-main-nav-trigger');
+  const search = document.querySelector('.js-search');
 
   addEvent(navTrigger, 'click', function(){
     var text = navTrigger.innerText;
@@ -21,6 +22,7 @@ function toggleNav(){
     nav.classList.toggle('nav-open');
     auxNav.classList.toggle('nav-open');
     navTrigger.classList.toggle('nav-open');
+    search.classList.toggle('nav-open');
     navTrigger.innerText = textToggle;
     navTrigger.setAttribute('data-text-toggle', text);
     textToggle = text;

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: just-the-docs
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Patrick Marsceill
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-22 00:00:00.000000000 Z
+date: 2018-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll