jekyll-theme-basically-basic 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8c5b0fb77ba201d31e0fa3d2a564179032c9b619
-  data.tar.gz: 1ef5d067aeb68ea4e6937f6ab6b6e4fc60f9c811
+  metadata.gz: f2e0ab57f483f56071db22e3e78effbd02cd3995
+  data.tar.gz: b664f1ffb586edaf91b519aa576d462ce1a8a399
 SHA512:
-  metadata.gz: 5e5ec8132130fe21f317d293e66920f4a480bceae0fedec5e60f20bb0427ea25d7a5d452bb955e208c527f867ff6d6ae5af28c5cf3827b313ae9738b4b5a4612
-  data.tar.gz: fa96e40f23e536a607e880e5c7707b805e4171c240f6655abdf3e17c1331bb40a0652b2e0d5bfeb914bcbef02ecd43eb7d8bf97c0e6bdc8dfe14d1d6ef783565
+  metadata.gz: c37d965922b6c8ba8f035b524f0d7fe9768f0f0a6ae98e2696bc758bae9cdd353e649e5260f3451d6e049297318875c6abbeb6a43a2426c3649c9932d92dc4f9
+  data.tar.gz: c9b2989456d7cc6fcb07b9c2efd97a43decd6057f8a9f37a37dd582d645269a96826242d777080ac0d9bf2b5b6b7cb31613b6478ba721e6204794ff6b75326c4

data/CHANGELOG.md

@@ -1,14 +1,31 @@
-# Change Log
-
-All notable changes to this project will be documented in this file.
-
-The format is based on [Keep a Changelog](http://keepachangelog.com/)
-and this project adheres to [Semantic Versioning](http://semver.org/).
-
-## [1.0.1] - 2017-03-23
-### Added
-- Responsive embed helper classes for videos. [#2](https://github.com/mmistakes/jekyll-theme-basically-basic/issues/2)
-- Print styles for improved readability of printed pages. [#4](https://github.com/mmistakes/jekyll-theme-basically-basic/pull/4)
-- Icon list to README.
-
-## [1.0.0] - 2017-03-20
+# Change Log
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+## [Unreleased]
+
+## [1.1.0] - 2017-03-30
+### Added
+- Improved installation documentation. [#8](https://github.com/mmistakes/jekyll-theme-basically-basic/issues/8)
+- Google Analytics tracking ID, Disqus comments, to `/docs` demo site.
+
+### Changed
+- Change source order of `.sidebar` and `.canvas` so menu items can easily be "tabbed" to. [#10](https://github.com/mmistakes/jekyll-theme-basically-basic/issues/10)
+- Refactor sidebar off-canvas menu and improve animation. [#9](https://github.com/mmistakes/jekyll-theme-basically-basic/issues/9) [#15](https://github.com/mmistakes/jekyll-theme-basically-basic/issues/15)
+- Removed tinted background from `<th>` elements.
+- Permalink structure of `/docs` demo site.
+
+### Fixed
+- `body` height and `.wrapper` box shadow. [#13](https://github.com/mmistakes/jekyll-theme-basically-basic/issues/13)
+- Unclickable main content links in Internet Explorer 10. [#9](https://github.com/mmistakes/jekyll-theme-basically-basic/issues/9)
+
+## [1.0.1] - 2017-03-23
+### Added
+- Responsive embed helper classes for videos. [#2](https://github.com/mmistakes/jekyll-theme-basically-basic/issues/2)
+- Print styles for improved readability of printed pages. [#4](https://github.com/mmistakes/jekyll-theme-basically-basic/pull/4)
+- Icon list to README.
+
+## [1.0.0] - 2017-03-20

data/README.md

@@ -23,7 +23,13 @@ with a few enhancements thrown in for good measure:
 ## Table of Contents
 
 1. [Installation](#installation)
-2. [Configuration](#configuration)
+   1. [Ruby Gem Method](#ruby-gem-method)
+   2. [GitHub Pages Compatible Method](#github-pages-compatible-method)
+      1. [Remove the Unnecessary](#remove-the-unnecessary)
+2. [Structure](#structure)
+   1. [Starting Fresh](#starting-fresh)
+   2. [Starting from jekyll new](#starting-from-jekyll-new)
+3. [Configuration](#configuration)
    1. [Skin](#skin)
    2. [Google Fonts](#google-fonts)
    3. [Text](#text)
@@ -33,26 +39,33 @@ with a few enhancements thrown in for good measure:
    7. [Reading Time](#reading-time)
    8. [Comments (via Disqus)](#comments-via-disqus)
    9. [Google Analytics](#google-analytics)
-3. [Layouts](#layouts)
+4. [Layouts](#layouts)
    1. [Default](#layout-default)
    2. [Post](#layout-post)
    3. [Page](#layout-page)
    4. [Home](#layout-home)
    5. [About](#layout-about)
    6. [Curriculum Vitæ/Resume](#layout-cv)
-4. [Customization](#customization)
+5. [Customization](#customization)
    1. [Overriding Includes and Layouts](#overriding-includes-and-layouts)
    2. [Customizing Sass (SCSS)](#customizing-sass-scss)
    3. [Customizing JavaScript](#customizing-javascript)
    4. [SVG Icons](#svg-icons)
    5. [Customizing Sidebar Content](#customizing-sidebar-content)
-5. [Development](#development)
-6. [Contributing](#contributing)
+6. [Development](#development)
+7. [Contributing](#contributing)
    1. [Pull Requests](#pull-requests)
-7. [Credits](#credits)
+8. [Credits](#credits)
 
 ## Installation
 
+If you're running Jekyll v3.3+ and self-hosting you can quickly install the 
+theme as Ruby gem. If you're hosting with GitHub Pages you'll have to use the 
+"repo fork" method or directly copy all of the theme files (see 
+[structure](#structure) below) into your project.
+
+### Ruby Gem Method
+
 1. Install the theme as a Ruby Gem by adding it to your `Gemfile` like so:
 
    ```ruby
@@ -72,9 +85,91 @@ with a few enhancements thrown in for good measure:
    theme: jekyll-theme-basically-basic
    ```
 
-**Note:** 3rd-party Ruby gem themes aren't currently supported on sites hosted 
-with [GitHub Pages](https://pages.github.com/). Basically Basic can still be 
-used on GH Pages, but you will need to fork the theme instead.
+### GitHub Pages Compatible Method
+
+Fork the [Basically Basic repo](https://github.com/mmistakes/jekyll-theme-basically-basic/fork), 
+then rename it to **USERNAME.github.io** --- replacing **USERNAME** with your 
+GitHub username.
+
+**Note:** Your Jekyll site should be viewable immediately at 
+<http://USERNAME.github.io>. If it's not, you can force a rebuild by 
+**configuring your site** (see below for more details).
+
+Replace the contents of `Gemfile` found in the root of your Jekyll site with 
+the following:
+
+```ruby
+source "https://rubygems.org"
+
+gem "github-pages", group: :jekyll_plugins
+```
+
+Then run `bundle update` and verify that the [GitHub Pages gem](https://github.com/github/pages-gem)
+and its dependencies install properly.
+
+#### Remove the Unnecessary
+
+If you forked or downloaded the `jekyll-theme-basically-basic` repo you can 
+safely remove the following files and folders:
+
+- `.codeclimate.yml`
+- `.editorconfig`
+- `.gitattributes`
+- `.github`
+- `.scss-lint.yml`
+- `CHANGELOG.md`
+- `jekyll-theme-basically-basic.gemspec`
+- `LICENSE.md`
+- `Rakefile`
+- `README.md`
+- `screenshot.png`
+- `/docs`
+- `/example`
+
+## Structure
+
+Layouts, includes, Sass partials, and data files are all placed in their default 
+locations. Stylesheets and scripts in `assets`, and a few development related 
+files in the project's root directory.
+
+**Please note:** If you installed Basically Basic via the Ruby Gem method, theme 
+files found in `/_layouts`, `/_includes`, `/_sass`, and `/assets` will be 
+missing. This is normal as they are bundled with the [`jekyll-theme-basically-basic`](https://rubygems.org/gems/jekyll-theme-basically-basic) gem.
+
+```bash
+jekyll-theme-basically-basic
+├── _data                      # data files
+|  └── theme.yml               # theme settings and custom text
+├── _includes                  # theme includes and SVG icons
+├── _layouts                   # theme layouts (see below for details)
+├── _sass                      # Sass partials
+├── assets
+|  ├── javascripts
+|  |  └── main.js
+|  └── stylesheets
+|     └── main.scss
+├── _config.yml                # sample configuration
+└── index.md                   # sample home page (all posts/not paginated)
+```
+
+### Starting Fresh
+
+After creating a `Gemfile` and installing the theme you'll need to add and edit 
+the following files:
+
+- [`_config.yml`](_config.yml)
+- [`/_data/theme.yml`](_data/theme.yml)
+- [`index.md`](index.md) 
+
+**Note:** Consult the [**pagination**](#pagination) documentation below for
+instructions on how to enable it for the home page.
+
+### Starting from `jekyll new`
+
+Using the `jekyll new` command will get you up and running the quickest.
+
+Edit `_config.yml` and create `_data/theme.yml` as instructed above and you're 
+good to go.
 
 ## Configuration
 
@@ -196,13 +291,18 @@ following pagination settings:
    ```
 
 3. Create `index.html` (or rename `index.md`) in the root of your project and 
-add `layout: home` `paginate: true` to its YAML Front Matter.
+add the following front matter:
+
+   ```yaml
+   layout: home
+   paginate: true
+   ```
 
 ### Author
 
 Author information is used as meta data for post "by lines" and propagates the 
-`creator` field of Twitter summary cards with the following YAML Front Matter 
-in `_config.yml`:
+`creator` field of Twitter summary cards with the following front matter in 
+`_config.yml`:
 
 ```yaml
 author:
@@ -211,8 +311,8 @@ author:
   picture: /assets/images/johndoe.png
 ```
 
-Site-wide author information can be overridden in a document's YAML Front Matter 
-in the same way:
+Site-wide author information can be overridden in a document's front matter in 
+the same way:
 
 ```yaml
 author:
@@ -221,9 +321,9 @@ author:
   picture: /assets/images/janedoe.png
 ```
 
-Or by specifying a corresponding key in the document's YAML Front Matter, that 
+Or by specifying a corresponding key in the document's front matter, that 
 exists in `site.data.authors`. E.g., you have the following in the document's 
-YAML Front Matter:
+front matter:
 
 ```yaml
 author: megaman
@@ -268,7 +368,7 @@ with the following [environment value](http://jekyllrb.com/docs/configuration/#s
 `JEKYLL_ENV=production`
 
 If you don't want to display comments for a particular post you can disable 
-them by adding `comments: false` to that post's YAML Front Matter.
+them by adding `comments: false` to that post's front matter.
 
 ### Google Analytics
 
@@ -302,7 +402,7 @@ and provide additional styling and features inside of the `{{ content }}` block.
 
 ### `layout: post`
 
-This layout accommodates the following YAML Front Matter:
+This layout accommodates the following front matter:
 
 ```yaml
 # optional alternate title to replace page.title at the top of the page
@@ -344,7 +444,7 @@ differences.
 
 ### `layout: home`
 
-This layout accommodates the same YAML Front Matter as `layout: page`, with the 
+This layout accommodates the same front matter as `layout: page`, with the 
 addition of the following:
 
 ```yaml
@@ -353,7 +453,7 @@ paginate: true  # enables pagination loop, see section above for additional setu
 
 ### `layout: about`
 
-This layout accommodates the same YAML Front Matter as `layout: page`, with the 
+This layout accommodates the same front matter as `layout: page`, with the 
 addition of the following to display an author picture:
 
 ```yaml
@@ -363,14 +463,14 @@ author:
 ```
 
 Recommended `picture` size is approximately `300 x 300` pixels. If `author` 
-object is not explicitly set in the about page's YAML Front Matter the theme 
+object is not explicitly set in the about page's front matter the theme 
 will default to the value set in `_config.yml`.
 
 If blank there no image will appear.
 
 ### `layout: cv`
 
-This layout accommodates the same YAML Front Matter as `layout: page`. It 
+This layout accommodates the same front matter as `layout: page`. It 
 leverages a [JSON-based file standard](https://jsonresume.org/schema/) for 
 resume data to conveniently render a curriculum vitæ or resume painlessly.
 
@@ -558,8 +658,9 @@ When submitting a pull request:
    `my-awesome-new-feature`) and describe the feature or fix.
 3. Open a pull request on GitHub.
 
-Sample pages can be found in the [`/docs`](docs) folder if you'd like to tackle 
-any "low-hanging fruit" like fixing typos, bad grammar, etc.
+Sample pages can be found in the [`/docs`](docs) and [`/example`](/example) 
+folders if you'd like to tackle any "low-hanging fruit" like fixing typos, bad 
+grammar, etc.
 
 ---
 

data/_includes/skip-links.html

@@ -1,8 +1,8 @@
-<section>
+<nav class="skip-links">
   <h2 class="screen-reader-text">{{ site.data.theme.t.skip_links | default: 'Skip links' }}</h2>
-  <ul class="skip-links">
+  <ul>
     <li><a href="#primary-nav" class="screen-reader-shortcut">{{ site.data.theme.t.skip_primary_nav | default: 'Skip to primary navigation' }}</a></li>
     <li><a href="#main" class="screen-reader-shortcut">{{ site.data.theme.t.skip_content | default: 'Skip to content' }}</a></li>
     <li><a href="#footer" class="screen-reader-shortcut">{{ site.data.theme.t.skip_footer | default: 'Skip to footer' }}</a></li>
   </ul>
-</section>
+</nav>

data/_layouts/default.html

@@ -1,38 +1,42 @@
-<!DOCTYPE html>
-<!--
-    Basically Basic Jekyll Theme 1.0.1
-    Copyright 2017 Michael Rose - mademistakes.com | @mmistakes
-    Free for personal and commercial use under the MIT license
-    https://github.com/mmistakes/jekyll-basically-theme/blob/master/LICENSE.md
--->
-<html lang="{{ page.lang | default: site.lang | default: 'en-US' }}" class="no-js">
-  {% include head.html %}
-
-  <body class="layout--{{ page.layout | default: layout.layout }}{% if page.classes or layout.classes %}{{ page.classes | default: layout.classes | join: ' ' | prepend: ' ' }}{% endif %} {{ page.title | slugify }}">
-
-    {% include skip-links.html %}
-
-    <div class="sidebar-toggle-wrapper">
-      <a class="toggle navicon-button larr" href="#sidebar">
-        <span class="sidebar-toggle-label">{{ site.data.theme.t.menu | default: 'Menu' }}</span>
-        <div class="navicon"></div>
-      </a>
-    </div>
-
-    <div class="wrapper">
-      {% include masthead.html %}
-      {{ content }}
-    </div>
-
-    <div id="sidebar" class="sidebar">
-      <div class="inner">
-        {% include navigation.html %}
-        {% include contact-list.html %}
-      </div>
-    </div>
-
-    {% include scripts.html %}
-
-  </body>
-
-</html>
+<!DOCTYPE html>
+<!--
+    Basically Basic Jekyll Theme 1.1.0
+    Copyright 2017 Michael Rose - mademistakes.com | @mmistakes
+    Free for personal and commercial use under the MIT license
+    https://github.com/mmistakes/jekyll-basically-theme/blob/master/LICENSE.md
+-->
+<html lang="{{ page.lang | default: site.lang | default: 'en-US' }}" class="no-js">
+  {% include head.html %}
+
+  <body class="layout--{{ page.layout | default: layout.layout }}{% if page.classes or layout.classes %}{{ page.classes | default: layout.classes | join: ' ' | prepend: ' ' }}{% endif %} {{ page.title | slugify }}">
+
+    {% include skip-links.html %}
+
+    <div class="sidebar-toggle-wrapper">
+      <button class="toggle navicon-button larr" type="button">
+        <span class="toggle-inner">
+          <span class="sidebar-toggle-label">{{ site.data.theme.t.menu | default: 'Menu' }}</span>
+          <span class="navicon"></span>
+        </span>
+      </button>
+    </div>
+
+    <div id="sidebar" class="sidebar">
+      <div class="inner">
+        {% include navigation.html %}
+        {% include contact-list.html %}
+      </div>
+    </div>
+
+    <div class="canvas">
+      <div class="wrapper">
+        {% include masthead.html %}
+        {{ content }}
+      </div>
+    </div>
+
+    {% include scripts.html %}
+
+  </body>
+
+</html>

data/_sass/basically-basic.scss

@@ -1,41 +1,41 @@
-/*!
- * Basically Basic Jekyll Theme 1.0.1
- * Copyright 2017 Michael Rose - mademistakes | @mmistakes
- * Free for personal and commercial use under the MIT license
- * https://github.com/mmistakes/jekyll-theme-basically-basic/blob/master/LICENSE.md
-*/
-
-/* Mixins and functions */
-@import 'basically-basic/vendor/susy';
-@import 'basically-basic/vendor/breakpoint';
-@include breakpoint-set('to ems', true);
-@import 'basically-basic/mixins';
-
-/* Variables */
-@import 'basically-basic/variables';
-
-/* Core CSS */
-@import 'basically-basic/reset';
-@import 'basically-basic/base';
-@import 'basically-basic/layout';
-@import 'basically-basic/tables';
-
-/* Components */
-@import 'basically-basic/global';
-@import 'basically-basic/sidebar';
-@import 'basically-basic/navigation';
-@import 'basically-basic/footer';
-@import 'basically-basic/entries';
-@import 'basically-basic/buttons';
-@import 'basically-basic/icons';
-@import 'basically-basic/intro';
-@import 'basically-basic/navicons';
-@import 'basically-basic/contact-lists';
-@import 'basically-basic/syntax-highlighting';
-@import 'basically-basic/responsive-embed';
-
-/* Utility classes */
-@import 'basically-basic/utilities';
-
-/* Print */
-@import 'basically-basic/print';
+/*!
+ * Basically Basic Jekyll Theme 1.1.0
+ * Copyright 2017 Michael Rose - mademistakes | @mmistakes
+ * Free for personal and commercial use under the MIT license
+ * https://github.com/mmistakes/jekyll-theme-basically-basic/blob/master/LICENSE.md
+*/
+
+/* Mixins and functions */
+@import 'basically-basic/vendor/susy';
+@import 'basically-basic/vendor/breakpoint';
+@include breakpoint-set('to ems', true);
+@import 'basically-basic/mixins';
+
+/* Variables */
+@import 'basically-basic/variables';
+
+/* Core CSS */
+@import 'basically-basic/reset';
+@import 'basically-basic/base';
+@import 'basically-basic/layout';
+@import 'basically-basic/tables';
+
+/* Components */
+@import 'basically-basic/global';
+@import 'basically-basic/sidebar';
+@import 'basically-basic/navigation';
+@import 'basically-basic/footer';
+@import 'basically-basic/entries';
+@import 'basically-basic/buttons';
+@import 'basically-basic/icons';
+@import 'basically-basic/intro';
+@import 'basically-basic/navicons';
+@import 'basically-basic/contact-lists';
+@import 'basically-basic/syntax-highlighting';
+@import 'basically-basic/responsive-embed';
+
+/* Utility classes */
+@import 'basically-basic/utilities';
+
+/* Print */
+@import 'basically-basic/print';