Merge branch 'master' into header_pages_config

Author: benbalter

History.markdown

@@ -1,14 +1,36 @@
-## HEAD
+## 2.1.0 / 2016-11-15
+
+### Minor Enhancements
+
+  * Update gemspec to require at least Jekyll 3.3 (#59)
+  * Use `absolute_url` filter for disqus (#66)
+  * replace `example/index.html` with `example/index.md` (#58)
+
+### Development Fixes
+
+  * Example should require Jekyll 3.3 (#61)
+
+## 2.0.0 / 2016-10-06
 
 ### Minor Enhancements
 
   * priority to site.url when site.github.url is available (#46)
   * Move contents of the index.html page to the 'home' layout (#48)
+  * Use  new `absolute_url` and `relative_url` filters in minima (#57)
 
 ### Development Fixes
 
   * Use standardized tab size of 2 spaces (#44)
 
+### Major Enhancements
+
+  * move `css/` directory from jekyll into `assets/` (#43)
+
+### Bug Fixes
+
+  * Fix html proofer errors (#49)
+  * Update gem regex to include new `assets` directory (#54)
+
 ## 1.2.0 / 2016-09-12
 
 ### Minor Enhancements

README.md

@@ -22,18 +22,31 @@ And then execute:
 
     $ bundle
     
-Then add a `css/main.scss` file based on the following template, don't forget to include the frontmatter:
 
-```css
----
----
+## Usage
 
-@import "minima";
-```
+### Customization
+
+To override the default structure and style of minima, simply create the concerned directory at the root of your site, copy the file you wish to customize to that directory, and then edit the file.
+e.g., to override the [`_includes/head.html `](_includes/head.html) file to specify a custom style path, create an `_includes` directory, copy `_includes/head.html` from minima gem folder to `<yoursite>/_includes` and start editing that file.
 
-You can choose to override the [`_includes/head.html `](_includes/head.html) file to specify a custom style path.
+The site's default CSS has now moved to a new place within the gem itself, [`assets/main.scss`](assets/main.scss). To **override the default CSS**, the file has to exist at your site source. Do either of the following:
+- Create a new instance of `main.scss` at site source.
+  - Create a new file `main.scss` at `<your-site>/assets/`
+  - Add the frontmatter dashes, and
+  - Add `@import "minima";`, to `<your-site>/assets/main.scss`
+  - Add your custom CSS.
+- Download the file from this repo
+  - Create  a new file `main.scss` at `<your-site>/assets/`
+  - Copy the contents at [assets/main.scss](assets/main.scss) onto the `main.scss` you just created, and edit away!
+- Copy directly from Minima 2.0 gem
+  - Go to your local minima gem installation directory ( run `bundle show minima` to get the path to it ).
+  - Copy the `assets/` folder from there into the root of `<your-site>`
+  - Change whatever values you want, inside `<your-site>/assets/main.scss`
 
-## Enabling comments (via Disqus)
+--
+
+### Enabling comments (via Disqus)
 
 Optionally, if you have a Disqus account, you can tell Jekyll to use it to show a comments section below each post.
 
@@ -50,7 +63,9 @@ Comments are enabled by default and will only appear in production, i.e., `JEKYL
 
 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.
 
-## Enabling Google Analytics
+--
+
+### Enabling Google Analytics
 
 To enable Google Anaytics, add the following lines to your Jekyll site:
 

_includes/disqus_comments.html

@@ -1,15 +1,10 @@
 {% if page.comments != false and jekyll.environment == "production" %}
-  {% if site.url %}
-    {% assign disqus_url = page.url | prepend: site.url %}
-  {% elsif site.github.url %}
-    {% assign disqus_url = page.url | prepend: site.github.url %}
-  {% endif %}
 
   <div id="disqus_thread"></div>
   <script>
     var disqus_config = function () {
-      this.page.url = '{{ disqus_url }}';
-      this.page.identifier = '{{ disqus_url }}';
+      this.page.url = '{{ page.url | absolute_url }}';
+      this.page.identifier = '{{ page.url | absolute_url }}';
     };
 
     (function() {

_includes/footer.html

@@ -14,7 +14,9 @@ <h2 class="footer-heading">{{ site.title | escape }}</h2>
               {{ site.title | escape }}
             {% endif %}
             </li>
-          <li><a href="mailto:{{ site.email }}">{{ site.email }}</a></li>
+            {% if site.email %}
+            <li><a href="mailto:{{ site.email }}">{{ site.email }}</a></li>
+            {% endif %}
         </ul>
       </div>
 

_includes/head.html

@@ -6,11 +6,9 @@
   <title>{% if page.title %}{{ page.title | escape }}{% else %}{{ site.title | escape }}{% endif %}</title>
   <meta name="description" content="{{ page.excerpt | default: site.description | strip_html | normalize_whitespace | truncate: 160 | escape }}">
 
-  {% assign custom_url = site.url | append: site.baseurl %}
-  {% assign full_base_url = custom_url | default: site.github.url %}
-  <link rel="stylesheet" href="{{ "/css/main.css" | prepend: full_base_url }}">
-  <link rel="canonical" href="{{ page.url | replace:'index.html','' | prepend: full_base_url }}">
-  <link rel="alternate" type="application/rss+xml" title="{{ site.title | escape }}" href="{{ "/feed.xml" | prepend: full_base_url }}">
+  <link rel="stylesheet" href="{{ "/assets/main.css" | relative_url }}">
+  <link rel="canonical" href="{{ page.url | replace:'index.html','' | absolute_url }}">
+  <link rel="alternate" type="application/rss+xml" title="{{ site.title | escape }}" href="{{ "/feed.xml" | relative_url }}">
 
   {% if jekyll.environment == 'production' and site.google_analytics %}
   {% include google-analytics.html %}

_includes/header.html

@@ -1,27 +1,24 @@
 <header class="site-header" role="banner">
 
   <div class="wrapper">
-
-    {% assign custom_url = site.url | append: site.baseurl %}
-    {% assign full_base_url = custom_url | default: site.github.url %}
     {% assign default_paths = site.pages | map: "path" %}
     {% assign page_paths = site.header_pages | default: default_paths %}
-    <a class="site-title" href="{{ full_base_url }}/">{{ site.title | escape }}</a>
+    <a class="site-title" href="{{ "/" | relative_url }}">{{ site.title | escape }}</a>
 
     <nav class="site-nav">
-      <a href="#" class="menu-icon">
+      <span class="menu-icon">
         <svg viewBox="0 0 18 15" width="18px" height="15px">
           <path fill="#424242" d="M18,1.484c0,0.82-0.665,1.484-1.484,1.484H1.484C0.665,2.969,0,2.304,0,1.484l0,0C0,0.665,0.665,0,1.484,0 h15.031C17.335,0,18,0.665,18,1.484L18,1.484z"/>
           <path fill="#424242" d="M18,7.516C18,8.335,17.335,9,16.516,9H1.484C0.665,9,0,8.335,0,7.516l0,0c0-0.82,0.665-1.484,1.484-1.484 h15.031C17.335,6.031,18,6.696,18,7.516L18,7.516z"/>
           <path fill="#424242" d="M18,13.516C18,14.335,17.335,15,16.516,15H1.484C0.665,15,0,14.335,0,13.516l0,0 c0-0.82,0.665-1.484,1.484-1.484h15.031C17.335,12.031,18,12.696,18,13.516L18,13.516z"/>
         </svg>
-      </a>
+      </span>
 
       <div class="trigger">
         {% for path in page_paths %}
           {% assign my_page = site.pages | where: "path", path | first %}
           {% if my_page.title %}
-          <a class="page-link" href="{{ my_page.url | prepend: full_base_url }}">{{ my_page.title | escape }}</a>
+          <a class="page-link" href="{{ my_page.url | relative_url }}">{{ my_page.title | escape }}</a>
           {% endif %}
         {% endfor %}
       </div>

_layouts/home.html

@@ -8,21 +8,18 @@ <h1 class="page-heading">Posts</h1>
 
   {{ content }}
 
-  {% assign custom_url = site.url | append: site.baseurl %}
-  {% assign full_base_url = custom_url | default: site.github.url %}
-
   <ul class="post-list">
     {% for post in site.posts %}
       <li>
         <span class="post-meta">{{ post.date | date: "%b %-d, %Y" }}</span>
 
         <h2>
-          <a class="post-link" href="{{ post.url | prepend: full_base_url }}">{{ post.title | escape }}</a>
+          <a class="post-link" href="{{ post.url | relative_url }}">{{ post.title | escape }}</a>
         </h2>
       </li>
     {% endfor %}
   </ul>
 
-  <p class="rss-subscribe">subscribe <a href="{{ "/feed.xml" | prepend: full_base_url }}">via RSS</a></p>
+  <p class="rss-subscribe">subscribe <a href="{{ "/feed.xml" | relative_url }}">via RSS</a></p>
 
 </div>

assets/main.scss

@@ -0,0 +1,39 @@
+---
+# Only the main Sass file needs front matter (the dashes are enough)
+---
+@charset "utf-8";
+
+// Our variables
+$base-font-family: "Helvetica Neue", Helvetica, Arial, sans-serif;
+$base-font-size:   16px;
+$base-font-weight: 400;
+$small-font-size:  $base-font-size * 0.875;
+$base-line-height: 1.5;
+
+$spacing-unit:     30px;
+
+$text-color:       #111;
+$background-color: #fdfdfd;
+$brand-color:      #2a7ae2;
+
+$grey-color:       #828282;
+$grey-color-light: lighten($grey-color, 40%);
+$grey-color-dark:  darken($grey-color, 25%);
+
+// Width of the content area
+$content-width:    800px;
+
+$on-palm:          600px;
+$on-laptop:        800px;
+
+// Minima also includes a mixin for defining media queries.
+// Use media queries like this:
+// @include media-query($on-palm) {
+//     .wrapper {
+//         padding-right: $spacing-unit / 2;
+//         padding-left: $spacing-unit / 2;
+//     }
+// }
+
+// Import partials from the `minima` theme.
+@import "minima";

example/Gemfile

@@ -1,4 +1,4 @@
 source "https://rubygems.org"
 
-gem "jekyll", "~> 3.2"
+gem "jekyll", "~> 3.3"
 gem "minima", path: "../"