just-the-docs 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0ecd37ee5242601c4d73cd2d0a00bfd73963eb9b
-  data.tar.gz: a34f83ac6ab23a3a0a186042829c1738303c06a4
+  metadata.gz: 24dd899d0e58e3f017eb7e4cf322761abbdce70f
+  data.tar.gz: bfb670c5f67603a324f55bd57792f9f56408ce2c
 SHA512:
-  metadata.gz: 6df5119da4649595d5065930589a8dae29bc65bb0b2fcb82a80836b4d1f5250ac0c5fbf6f4bd1335ab982ea0bc87f50d91d5339c58a9b477ce17f5efb10c9954
-  data.tar.gz: d088255c745afbaa2d52ab0ac60135cabc4b927384956fad791c8da20ea1e8f9b94b48b45be836ab514798075736cd59aca7b492c95da809922e7f5823e65ce0
+  metadata.gz: 4af98f3860fef1cca28f8aa12c492e18a99f97e1f1d38eb2030b732079154ca667265d089abb62c63c40f5a4462fa3b8d7fc962266a3a5e5f60dd8371e6ce425
+  data.tar.gz: 02b93e7aed292ef07bbfd569826893701bdcb4ee8064615b2a783443dfc5a8d0731bf0ca6c4339847ebbb7d3d069e197ae71e1535fe573e5376fe8cbb40fc1f8

data/README.md

@@ -1,10 +1,17 @@
-# Just the Docs
+<p align="right">
+    <a href="https://badge.fury.io/rb/just-the-docs"><img src="https://badge.fury.io/rb/just-the-docs.svg" alt="Gem version"></a> <a href="https://travis-ci.com/pmarsceill/just-the-docs"><img src="https://travis-ci.com/pmarsceill/just-the-docs.svg?branch=master" alt="Build status"></a>
+</p>
+<br><br>
+<p align="center">
+    <h1 align="center">Just the Docs</h1>
+    <p align="center">A modern, high customizable, responsive Jekyll theme for documentation with built-in search.<br>Easily hosted on GitHub pages with few dependencies.</p>
+    <p align="center"><strong><a href="https://pmarsceill.github.io/just-the-docs">See it in action!</a></strong></p>
+    <br><br><br>
+</p>
 
-A nice looking, high customizable, responsive Jekyll theme for documention with built-in search. Easily hosted on GitHub pages.
 
 ![jtd](https://user-images.githubusercontent.com/896475/47384541-89053c80-d6d5-11e8-98dc-dba16e192de9.gif)
 
-
 ## Installation
 
 Add this line to your Jekyll site's Gemfile:
@@ -35,6 +42,20 @@ Or install it yourself as:
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/pmarsceill/just-the-docs. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
+### Submitting code changes:
+
+- Open a [Pull Request](https://github.com/pmarsceill/just-the-docs/pulls)
+- Ensure all CI tests pass
+- Await code review
+- Bump the version number in `just-the-docs.gemspec` and `package.json` according to [semantic versioning](https://semver.org/).
+
+### Design and development principles of this theme:
+
+1. As few dependencies as possible
+2. No build script needed
+3. First class mobile experience
+4. Make the content shine
+
 ## Development
 
 To set up your environment to develop this theme, run `bundle install`.
@@ -43,16 +64,6 @@ Your theme is setup just like a normal Jekyll site! To test your theme, run `bun
 
 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
 
 The theme is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/_includes/head.html

@@ -4,7 +4,9 @@
 
   <title>{{ page.title }} - {{ site.title }}</title>
   <link rel="stylesheet" href="{{ "/assets/css/just-the-docs.css" | absolute_url }}">
+  {% if site.search_enabled != nil %}
   <script type="text/javascript" src="{{ "/assets/js/vendor/lunr.min.js" | absolute_url }}"></script>
+  {% endif %}
   <script type="text/javascript" src="{{ "/assets/js/just-the-docs.js" | absolute_url }}"></script>
 
   <meta name="viewport" content="width=device-width, initial-scale=1">

data/_layouts/default.html

@@ -16,7 +16,8 @@
     </div>
     <div class="main-content-wrap">
       <div class="page-header">
-        <div class="main-content pb-0">
+        <div class="main-content">
+          {% if site.search_enabled != nil %}
           <div class="search js-search">
             <div class="search-input-wrap">
               <input type="text" class="js-search-input search-input" placeholder="Search {{ site.title }}" aria-label="Search {{ site.title }}" autocomplete="off">
@@ -24,8 +25,9 @@
             </div>
             <div class="js-search-results search-results-wrap"></div>
           </div>
+          {% endif %}
           {% if site.aux_links != nil %}
-            <ul class="list-style-none text-small mt-md-2 pb-4 pb-md-0 js-aux-nav aux-nav">
+            <ul class="list-style-none text-small mt-md-1 mb-md-1 pb-4 pb-md-0 js-aux-nav aux-nav">
               {% for link in site.aux_links %}
                 <li class="d-inline-block my-0{% unless forloop.last %} mr-2{% endunless %}"><a href="{{ link.last }}">{{ link.first }}</a></li>
               {% endfor %}

data/_sass/base.scss

@@ -1,7 +1,7 @@
 //
 // Base element style overrides
 //
-// stylelint-disable selector-no-type
+// stylelint-disable selector-no-type, selector-max-type
 
 * {
   box-sizing: border-box;

data/_sass/code.scss

@@ -1,7 +1,7 @@
 //
 // Code and syntax highlighting
 //
-// stylelint-disable selector-no-qualifying-type, declaration-block-semicolon-newline-after,declaration-block-single-line-max-declarations, selector-no-type
+// stylelint-disable selector-no-qualifying-type, declaration-block-semicolon-newline-after,declaration-block-single-line-max-declarations, selector-no-type, selector-max-type
 
 code {
   padding: 0.2em 0.15em;

data/_sass/content.scss

@@ -1,7 +1,7 @@
 //
 // Styles for rendered markdown in the .main-content container
 //
-// stylelint-disable selector-no-type, max-nesting-depth, selector-max-compound-selectors
+// stylelint-disable selector-no-type, max-nesting-depth, selector-max-compound-selectors, selector-max-type
 
 .page-content {
   ul,
@@ -56,6 +56,23 @@
     }
   }
 
+  .task-list {
+    padding-left: 0;
+  }
+
+  .task-list-item {
+    display: flex;
+    align-items: center;
+
+    &::before {
+      content: "";
+    }
+  }
+
+  .task-list-item-checkbox {
+    margin-right: 0.6em;
+  }
+
   hr + * {
     margin-top: 0;
   }

data/_sass/labels.scss

@@ -12,9 +12,9 @@
   margin-right: $sp-1;
   margin-left: $sp-1;
   color: $white;
+  text-transform: uppercase;
   vertical-align: middle;
   background-color: $blue-100;
-  text-transform: uppercase;
   @include fs-2;
 }
 

data/_sass/layout.scss

@@ -79,8 +79,6 @@
 
   @include mq(md) {
     background-color: $white;
-    border-bottom: $border $border-color;
-
   }
 
   .main-content {
@@ -88,8 +86,11 @@
 
     @include mq(md) {
       display: flex;
-      justify-content: space-between;
+      justify-content: flex-end;
+      height: 60px;
       padding-top: $sp-4;
+      padding-bottom: $sp-4;
+      border-bottom: $border $border-color;
     }
   }
 }
@@ -115,6 +116,7 @@
   }
 }
 
+// stylelint-disable selector-no-type
 body {
   position: relative;
   padding-bottom: $sp-10;
@@ -124,6 +126,7 @@ body {
     padding-bottom: 0;
   }
 }
+// stylelint-enable selector-no-type
 
 .site-footer {
   position: absolute;

data/_sass/navigation.scss

@@ -11,10 +11,10 @@
     position: absolute;
     top: 0;
     right: 0;
+    z-index: 101;
     height: 60px;
     padding-top: $sp-4;
-    z-index: 101;
-    box-shadow: inset 0 -1px 0 $border-color;
+    border-bottom: $border $border-color;
   }
 }
 
@@ -38,6 +38,8 @@
   }
 
   .navigation-list-item {
+    position: relative;
+
     &::before {
       position: absolute;
       margin-top: 0.3em;
@@ -89,7 +91,6 @@
   }
 }
 
-
 .navigation-list-toggle {
   position: absolute;
   right: $sp-4;

data/_sass/search.scss

@@ -17,7 +17,7 @@
     display: block;
     padding-top: $sp-1;
     padding-right: 0;
-    padding-bottom: $sp-4;
+    padding-bottom: 0;
     padding-left: 0;
     margin-bottom: 0;
     background-color: transparent;

data/_sass/support/mixins/_layout.scss

@@ -15,20 +15,22 @@
     @media (min-width: rem($value)) {
       @content;
     }
-  } @else {
+  }
+
+  @else {
     @warn "No value could be retrieved from `#{$media-query}`. "
-        + "Please make sure it is defined in `$media-queries` map.";
+      + "Please make sure it is defined in `$media-queries` map.";
   }
 }
 
 // Responsive container
 
 @mixin container {
-  padding-left: $gutter-spacing-sm;
   padding-right: $gutter-spacing-sm;
+  padding-left: $gutter-spacing-sm;
 
   @include mq(md) {
-    padding-left: $gutter-spacing;
     padding-right: $gutter-spacing;
+    padding-left: $gutter-spacing;
   }
 }

data/_sass/tables.scss

@@ -1,7 +1,7 @@
 //
 // Tables
 //
-// stylelint-disable max-nesting-depth, selector-no-type
+// stylelint-disable max-nesting-depth, selector-no-type, selector-max-type
 
 table {
   display: block;

data/_sass/typography.scss

@@ -1,7 +1,7 @@
 //
 // Typography
 //
-// stylelint-disable primer/selector-no-utility, selector-no-type
+// stylelint-disable primer/selector-no-utility, selector-no-type, selector-max-type
 
 h1,
 .text-alpha {

data/assets/css/just-the-docs.scss

@@ -7,7 +7,7 @@
 // Import dependancies
 //
 
-@import "./normalize.scss/normalize.scss";
+@import "./vendor/normalize.scss/normalize.scss";
 
 //
 // Import Just the docs scss

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

@@ -155,7 +155,9 @@ function initSearch() {
 
 function ready(){
   toggleNav();
-  initSearch();
+  if (typeof lunr !== 'undefined') {
+    initSearch();
+  }
 }
 
 // in case the document is already rendered

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: just-the-docs
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Patrick Marsceill
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-24 00:00:00.000000000 Z
+date: 2018-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -77,9 +77,6 @@ files:
 - _sass/labels.scss
 - _sass/layout.scss
 - _sass/navigation.scss
-- _sass/normalize.scss/README.md
-- _sass/normalize.scss/normalize.scss
-- _sass/normalize.scss/package.json
 - _sass/search.scss
 - _sass/support/_functions.scss
 - _sass/support/_variables.scss
@@ -96,6 +93,9 @@ files:
 - _sass/utilities/_spacing.scss
 - _sass/utilities/_typography.scss
 - _sass/utilities/utilities.scss
+- _sass/vendor/normalize.scss/README.md
+- _sass/vendor/normalize.scss/normalize.scss
+- _sass/vendor/normalize.scss/package.json
 - assets/css/just-the-docs.scss
 - assets/images/just-the-docs.png
 - assets/images/search.svg