jambi 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 54b2a005a289f100aeb7b274bfd5897ce74e9541
-  data.tar.gz: 308c69b17909cc4313cdea829d824b7dd924e6e0
+  metadata.gz: 65ce58c537f627f70280d70cdab1723b6c7d3e78
+  data.tar.gz: b63b0453dc20c02d536612fb0d6c9c054296863e
 SHA512:
-  metadata.gz: a59ed901107dd4a6cd77bc4ab80c813e261f16cf14b32659abfc5db7fcd2a4e132a117681c8b95d7d2db76293289ceff06fcbcd01fa863e17432a6dcc77fb1ec
-  data.tar.gz: 4a0b7f4207346789ddfd5483ceb0e15069bc61cfad482dc8c78ddbbab035f2fc507518bc51cc39e8b34e90ce4ced7e76ffda36e1ada8a26b3d6c475cbbec32ef
+  metadata.gz: dfb84122f60758c43fdbe116aab95d2cc1feed44b6edbef00483d96bf904a2af21f2d58ef47611bf892a9c32fe0b99a2be7bfba0dee8d7fd1c2a9782ad404607
+  data.tar.gz: 3d6aefdeb0157791538c99f64f0e8e043aab603d73c14d635f3da4caefcff564d95dcf18b822d5e794d17214d5ebc90d04332e996ccc85eee1fdd7d870e6a59b

data/README.md

@@ -1,6 +1,6 @@
 # jambi
 
-A minimal Jekyll theme for documenting things you've built
+A minimal Jekyll theme for documenting things you've created.
 
 ## Installation
 
@@ -26,7 +26,52 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here. Describe your available layouts, includes, and/or sass.
+## Customizing
+
+### Configuration variables
+
+After installation, copy (then customize) these settings into your site's `_.config.yml` file:
+
+```yaml
+# Jambi settings
+me:
+  name: Your Name
+  tagline: These are the things I create
+  photo: "/images/header/me.jpg"
+google_analytics: UA-XXXXXXXXX-X
+excerpt_separator: <!--more-->  # you can specify your own separator, of course.
+permalink: pretty
+highlighter: rouge
+sass:
+  style: compressed
+defaults:
+  -
+    scope:
+      path: ""
+      type: "posts"
+    values:
+      layout: "post"
+  -
+    scope:
+      path: ""
+      type: "pages"
+    values:
+      layout: "page"
+```
+
+### Stylesheet
+
+If you'd like to add your own custom styles:
+
+1. Create a file called `/assets/css/style.scss` in your site
+2. Add the following content to the top of the file, exactly as shown:
+    ```scss
+    ---
+    ---
+
+    @import "{{ site.theme }}";
+    ```
+3. Add any custom CSS (or Sass, including imports) you'd like immediately after the `@import` line
 
 ## Contributing
 

data/_includes/accounts.html

@@ -1,14 +1,14 @@
 <p class="usernames">
-  {% if site.me.username.github %}
-    <a href="https://github.com/{{ site.me.username.github }}"><i class="github"></i></a>
+  {% if site.github_username %}
+    <a href="https://github.com/{{ site.github_username }}"><i class="github"></i></a>
   {% endif %}
-  {% if site.me.username.twitter %}
-    <a href="https://twitter.com/{{ site.me.username.twitter }}"><i class="twitter"></i></a>
+  {% if site.twitter_username %}
+    <a href="https://twitter.com/{{ site.twitter_username }}"><i class="twitter"></i></a>
   {% endif %}
-  {% if site.me.username.linkedin %}
-    <a href="https://linkedin.com/{{ site.me.username.linkedin }}"><i class="linkedin"></i></a>
+  {% if site.linkedin_username %}
+    <a href="https://linkedin.com/{{ site.linkedin_username }}"><i class="linkedin"></i></a>
   {% endif %}
-  {% if site.me.email %}
-    <a class="email" href="mailto:{{ site.me.email }}">{{ site.me.email }}</a>
+  {% if site.email %}
+    <a class="email" href="mailto:{{ site.email }}">{{ site.email }}</a>
   {% endif %}
 </p>

data/_includes/analytics.html

@@ -0,0 +1,11 @@
+{% if site.google_analytics %}
+  <script>
+    (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+    (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+    m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+    })(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
+
+    ga('create', '{{ site.google_analytics }}', 'auto');
+    ga('send', 'pageview');
+  </script>
+{% endif %}

data/_includes/article-header.html

@@ -0,0 +1,12 @@
+<header>
+  <h1 itemprop="name headline">{{ include.post.title | escape }}</h1>
+  {% if include.post.subtitle %}
+    <h2>{{ include.post.subtitle | escape }}</h2>
+  {% endif %}
+  <p class="info">
+    <time datetime="{{ page.date | date_to_xmlschema }}" itemprop="datePublished">{{ include.post.date | date: "%b %-d, %Y" }}</time>
+    {% if include.post.category %}
+      <category>{{ include.post.category }}</category>
+    {% endif %}
+  </p>
+</header>

data/_includes/article-summary.html

@@ -1,21 +1,11 @@
-<article>
+<article class="post" itemscope itemtype="http://schema.org/BlogPosting">
   <a class="article-link" href="{{ include.post.url }}">
-    <header>
-      <h1>{{ include.post.title | escape }}</h1>
-      {% if include.post.subtitle %}
-        <h2>{{ include.post.subtitle | escape }}</h2>
-      {% endif %}
-      <p class="info">
-        <time>{{ include.post.date | date: "%b %-d, %Y" }}</time>
-        {% if include.category %}
-          <category>{{ include.post.category }}</category>
-        {% endif %}
-      </p>
-    </header>
+    {% include article-header.html post=include.post %}
     <content>
       <excerpt>
         {{ include.post.excerpt }}
       </excerpt>
+      <ellipsis>...</ellipsis>
     </content>
   </a>
 </article>

data/_includes/footer.html

@@ -5,4 +5,7 @@
       © {{ 'now' | date: "%Y" }} {{ site.me.name }}
     </p>
   </div>
-</header>
+</footer>
+{% if jekyll.environment == "production" %}
+  {% include analytics.html %}
+{% endif %}

data/_layouts/post.html

@@ -2,15 +2,7 @@
 layout: default
 ---
 <article class="post" itemscope itemtype="http://schema.org/BlogPosting">
-  <header>
-    <h1 itemprop="name headline">{{ page.title | escape }}</h1>
-    {% if page.subtitle %}
-      <h2>{{ page.subtitle | escape }}</h2>
-    {% endif %}
-    <time datetime="{{ page.date | date_to_xmlschema }}" itemprop="datePublished">
-      {{ page.date | date: "%b %-d, %Y" }}
-    </time>
-  </header>
+  {% include article-header.html post=page %}
   <content itemprop="articleBody">
     {{ content }}
   </content>

data/_sass/ui/article-list/_base.scss

@@ -18,5 +18,9 @@ article-list {
     excerpt {
 
     }
+
+    ellipsis {
+      color: $color-gray;
+    }
   }
 }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jambi
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Adam Draper
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-10 00:00:00.000000000 Z
+date: 2017-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -62,6 +62,8 @@ files:
 - LICENSE.txt
 - README.md
 - _includes/accounts.html
+- _includes/analytics.html
+- _includes/article-header.html
 - _includes/article-summary.html
 - _includes/footer.html
 - _includes/head.html
@@ -116,5 +118,5 @@ rubyforge_project:
 rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
-summary: A minimal Jekyll theme for documenting things you've built
+summary: A minimal Jekyll theme for documenting things you've created.
 test_files: []