jekyll-theme-kagami 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: '01910bda24f50ac32cd1e78d1c408e6ece87fd1a'
+  data.tar.gz: c5726fac8880cf911ea58f9536456345f1115040
+SHA512:
+  metadata.gz: e3a50cc5da0b8dfa5e73cbf14ced67f4b5bcac1ac84b40d61f49c0ae729280514afb16a8118a083a8d61b737dd45979d089e97913f2c68f16cdc9358a2fb8304
+  data.tar.gz: 53f9e5ba3640de394214633ec7f1cd6e0b7096cff610eb13b7f6ba0da1c8b4a2729c62e214e0218f2cc5bc818e1f17f698c6f39fd5e66a3d8eb27af6c10c4d54

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 kamikat
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,94 @@
+# Kagami
+
+[![Build Status](https://travis-ci.org/kamikat/jekyll-theme-kagami.svg?branch=master)](https://travis-ci.org/kamikat/jekyll-theme-kagami)
+
+A peaceful theme for Jekyll and GitHub Pages.
+
+## Installation
+
+Add this line to your Jekyll site's Gemfile:
+
+```ruby
+gem "jekyll-theme-kagami"
+```
+
+And add this line to your Jekyll site's `_config.yml`:
+
+```yaml
+theme: jekyll-theme-kagami
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jekyll-theme-kagami
+
+## Usage
+
+### Social Accounts
+
+You can customize social account links by adding following lines to `_config.yml`
+
+```yaml
+github_username: my_github_username
+twitter_username: my_twitter_username
+instagram_username: my_instagram_username
+```
+
+You can customize footer by overriding `_includes/footer.html`.
+
+### Syntax Highlighting
+
+Kagami support color schemes from [jekyll-pygments-themes](https://github.com/jwarby/jekyll-pygments-themes).
+
+Add the following lines to choose a color scheme:
+
+```yaml
+color_scheme: github
+```
+
+### 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.
+
+To enable it, add the following lines to your Jekyll site:
+
+```yaml
+disqus_shortname: my_disqus_shortname
+```
+
+You can find out more about Disqus' shortnames [here](https://help.disqus.com/customer/portal/articles/466208).
+
+Comments are enabled by default and will only appear in production, i.e., `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.
+
+### Enabling Google Analytics
+
+To enable Google Anaytics, add the following lines to your Jekyll site:
+
+```yaml
+google_analytics: UA-NNNNNNNN-N
+```
+
+Google Analytics will only appear in production, i.e., `JEKYLL_ENV=production`
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at <https://github.com/kamikat/jekyll-theme-kagami>. 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.
+
+## Development
+
+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.
+
+## License
+
+The theme is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/_includes/disqus.html

@@ -0,0 +1,17 @@
+<div id="disqus_thread"></div>
+<script>
+  var disqus_config = function () {
+    this.page.url = '{{ page.url | absolute_url }}';
+    this.page.identifier = '{{ page.url | absolute_url }}';
+  };
+
+  (function() {
+    var d = document, s = d.createElement('script');
+
+    s.src = 'https://{{ site.disqus_shortname }}.disqus.com/embed.js';
+
+    s.setAttribute('data-timestamp', +new Date());
+    (d.head || d.body).appendChild(s);
+  })();
+</script>
+<noscript>Please enable JavaScript to view the <a href="https://disqus.com/?ref_noscript" rel="nofollow">comments powered by Disqus.</a></noscript>

data/_includes/footer.html

@@ -0,0 +1,23 @@
+<footer class="site-footer">
+
+  <div class="wrapper">
+    <div class="credits">
+      KAGAMI, made with <i class="icon-heart"></i> by Kamikat
+    </div>
+    <div class="social-links">
+      <a class="social-link social-github" href="https://github.com/{{ site.github_username }}">
+        <i class="icon-github"></i>
+      </a>
+      <a class="social-link social-twitter" href="https://twitter.com/{{ site.twitter_username }}">
+        <i class="icon-twitter"></i>
+      </a>
+      <a class="social-link social-instagram" href="https://instagram.com/{{ site.instagram_username }}">
+        <i class="icon-instagram"></i>
+      </a>
+      <a class="social-link social-rss" href="{{ "/feed.xml" | relative_url  }}" target="_blank">
+        <i class="icon-rss"></i>
+      </a>
+    </div>
+  </div>
+
+</footer>

data/_includes/google-analytics.html

@@ -0,0 +1,11 @@
+<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>
+  

data/_includes/head.html

@@ -0,0 +1,23 @@
+<head>
+  <meta charset="utf-8">
+  <meta http-equiv="X-UA-Compatible" content="IE=edge">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+
+  <title>{% if page.title %}{{ page.title | append: " - " | append: site.title | escape }}{% else %}{{ site.title | escape }}{% endif %}</title>
+  <meta name="description" content="{{ page.excerpt | default: site.description | strip_html | normalize_whitespace | truncate: 160 | escape }}">
+
+  <link rel="stylesheet" href="{{ "/assets/styles/core.css" | relative_url }}">
+  <link rel="stylesheet" href="{{ "/assets/styles/fontello.css" | relative_url }}">
+  <link rel="stylesheet" href="{{ page.color_scheme | default: site.color_scheme | default: "default" | prepend: "/assets/styles/highlighting/" | append: ".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 page.mathjax or site.mathjax %}
+  <script src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML" type="text/javascript"></script>
+  {% endif %}
+
+  {% if jekyll.environment == 'production' and site.google_analytics %}
+  {% include google-analytics.html %}
+  {% endif %}
+</head>

data/_includes/header.html

@@ -0,0 +1,22 @@
+<header class="post-header">
+  <a class="site-title" href="{{ "/" | relative_url }}">{{ site.title | escape }}</a>
+  <h1 class="post-title">{{ page.title }}</h1>
+  <nav class="site-nav">
+    <div class="page-list">
+      {% assign sorted_pages = site.pages | sort: "position" %}
+      {% for my_page in sorted_pages %}
+      {% if my_page.title and my_page.url != "/" %}
+      <a class="page-link" href="{{ my_page.url | relative_url }}" >{{ my_page.name | downcase | remove: ".md" | escape }}</a>
+      {% endif %}
+      {% endfor %}
+    </div>
+  </nav>
+</header>
+
+{% if page.cover_url %}
+<div class="post-cover" aria-label="Cover">
+  <div class="post-cover-wrapper">
+    <img src="{{ page.cover_url }}" alt="" />
+  </div>
+</div>
+{% endif %}

data/_layouts/blank.html

@@ -0,0 +1,5 @@
+<!DOCTYPE html>
+<html lang="{{ site.lang | default: "en" }}">
+  {% include head.html %}
+  {{ content }}
+</html>

data/_layouts/default.html

@@ -0,0 +1,15 @@
+---
+layout: blank
+---
+
+<body>
+
+  <main class="page-content" aria-label="Content">
+    <div class="wrapper">
+      {{ content }}
+    </div>
+  </main>
+
+  {% include footer.html %}
+
+</body>

data/_layouts/home.html

@@ -0,0 +1,5 @@
+---
+layout: blank
+---
+
+{{ content }}

data/_layouts/page.html

@@ -0,0 +1,9 @@
+---
+layout: default
+---
+
+{% include header.html %}
+
+<article class="page" lang="{{ page.lang | default: site.lang | default: "en" }}" itemscope itemtype="http://schema.org/BlogPosting">
+  {{ content }}
+</article>

data/_layouts/post-list.html

@@ -0,0 +1,40 @@
+---
+layout: default
+---
+
+{% include header.html %}
+
+<ul class="post-list">
+  {% for post in site.posts %}
+  <li class="post-list-item" data-tags="{{ post.tags | join: " " }}">
+    <a class="post-item-link" href="{{ post.url | relative_url }}" data-date="{{ post.date | date: "%m-%d"  }}">
+      {{ post.title | escape }}
+    </a>
+    {% if post.description %}
+    <p class="post-description">{{ post.description }}</p>
+    {% endif %}
+    <div class="post-item-meta">
+      {{ post.date | date: "%B %-d, %Y" }}
+      /
+      {% capture lang %}{{ post.lang | default: site.lang | default: "en" }}{% endcapture %}
+      {% if lang == "en" %}
+      {% capture words %}{{ post.content | strip_html | number_of_words  }}{% endcapture %}
+      {% else %}
+      {% capture words %}{{ post.content | strip_html | size }}{% endcapture %}
+      {% endif %}
+      {% unless words contains "-" %}
+      {{ words | plus: 250 | divided_by: 250 | append: " minute read"  }}
+      {% endunless %}
+    </div>
+  </li>
+  {% endfor %}
+</ul>
+
+<script type="text/javascript">
+  var argparse = /([^=]+)=(.*)+/;
+  var h = window.location.hash, h = h && h.substr(1).split('&') || [], filters = {};
+  h.forEach(function (e) { var p = argparse.exec(e); if (p) filters[decodeURIComponent(p[1])] = decodeURIComponent(p[2]) });
+  if (filters.tags) document.querySelectorAll('.post-list li').forEach(function (e) {
+    e.style.display = !!~e.dataset.tags.indexOf(filters.tags) ? '' : 'none'
+  });
+</script>

data/_layouts/post.html

@@ -0,0 +1,42 @@
+---
+layout: default
+---
+<article class="post" lang="{{ page.lang | default: site.lang | default: "en" }}" itemscope itemtype="http://schema.org/BlogPosting" >
+
+  <header class="post-header">
+    <a class="site-title" href="{{ "/" | relative_url  }}">{{ site.title | escape  }}</a>
+    <h1 class="post-title" itemprop="name headline">{{ page.title | escape | replace: "​", "<wbr>" }}</h1>
+  </header>
+
+  {% if page.cover_url %}
+  <div class="post-cover" aria-label="Cover">
+    <div class="post-cover-wrapper">
+      <img src="{{ page.cover_url }}" alt="" />
+    </div>
+    <div class="cover-meta">{{ page.cover_meta | markdownify }}</div>
+  </div>
+  {% endif %}
+
+  <div class="post-content" itemprop="articleBody">
+    {{ content }}
+  </div>
+
+  <footer class="post-footer">
+    <div class="post-meta">
+      {% if page.date %} <time datetime="{{ page.date | date_to_xmlschema }}" itemprop="datePublished">{{ page.date | date: "%b %-d, %Y" }}</time> {% endif %}
+      {% if page.author %} by <span itemprop="author" itemscope itemtype="http://schema.org/Person"><span itemprop="name">{{ page.author | escape }}</span></span> {% endif %}
+    </div>
+
+    {% if page.tags.size > 0 %}
+    <ul class="post-tags" aria-label="TagList">
+      {% for tag in page.tags %}
+      <li><a class="tag-link" href="{{ tag | url_encode | prepend: "/#tags=" | relative_url }}">{{ tag | escape }}</a></li>
+      {% endfor %}
+    </ul>
+    {% endif %}
+  </footer>
+
+  {% if jekyll.environment == 'production' and site.disqus_shortname and page.comments != false %}
+  {% include disqus.html %}
+  {% endif %}
+</article>

data/_sass/kagami.scss

@@ -0,0 +1,23 @@
+@charset "utf-8";
+
+$font-size: 18px;
+
+// Dimensions
+$content-width: 680px;
+$spacing-unit: 32px;
+
+// Colors
+$content-color: #3c3c3c;
+$background-color: #fff;
+$border-color: #f0f0f0;
+$inline-code-color: #d32f2f;
+$inline-code-background: #fff6f6;
+$block-code-background: #f2f2fa;
+$mark-background: rgba(yellow, 0.35);
+
+@import "kagami/scut";
+@import "kagami/reset";
+@import "kagami/utility";
+@import "kagami/typeface";
+@import "kagami/layout";
+@import "kagami/typography";

data/_sass/kagami/_layout.scss

@@ -0,0 +1,163 @@
+$content-padding: $spacing-unit / 2;
+$post-margin-width: 2 * $spacing-unit;
+$post-header-spacing: 3.5 * $spacing-unit;
+$post-footer-spacing: 3 * $spacing-unit;
+
+html {
+  height: 100%;
+  overflow-x: hidden;
+}
+
+body {
+  min-height: 100%;
+  width: 100%;
+  overflow: hidden; // fixes margin-collapsing of body
+}
+
+.wrapper {
+  width: 100%;
+  max-width: $content-width;
+  margin: 0 auto;
+  padding-left: $content-padding;
+  padding-right: $content-padding;
+  @media screen and (min-width: $content-width) {
+    padding-left: $content-padding + $post-margin-width;
+    padding-right: $content-padding + $post-margin-width;
+  }
+}
+
+article {
+
+  $vspacing: $spacing-unit;
+  $hspacing: $spacing-unit / 2;
+
+  h1, h2, h3, h4, h5, h6, p, ul, ol, pre, hr, blockquote, img:only-child {
+    display: block;
+    margin-top: $vspacing;
+    margin-bottom: $vspacing;
+  }
+
+  li > ul, li > ol {
+    margin-top: 0;
+    margin-bottom: 0;
+  }
+
+  .highlight {
+    position: relative;
+    overflow: hidden;
+
+    code {
+      display: block;
+      overflow-x: auto;
+    }
+
+    @include exdent-horizontally($hspacing);
+    @include exdent-vertically(0.5 * $vspacing);
+
+    @media screen and (min-width: $content-width) {
+      @include exdent-horizontally(2 * $hspacing);
+    }
+  }
+
+  blockquote {
+    margin-left: 0.5 * $spacing-unit;
+    margin-right: 0.5 * $spacing-unit;
+    @media screen and (min-width: $content-width) {
+      margin-left: $spacing-unit;
+      margin-right: $spacing-unit;
+    }
+    cite {
+      display: block;
+      text-align: right;
+      margin-top: -$spacing-unit;
+      white-space: nowrap;
+    }
+  }
+
+  .aside, .sidenote {
+    width: 160px;
+    float: left;
+    margin-left: -$post-margin-width;
+    margin-right: $vspacing;
+    padding: 0;
+  }
+
+  @media screen and (max-width: $content-width) {
+    h2, h3, h4, h5, h6 {
+      &::before { color: rgba(0,0,0,0); }
+    }
+    .aside, .sidenote {
+      display: none;
+    }
+  }
+
+  h1, h2, h3, h4, h5, h6 { // reduce spacing after headings
+    & + *,
+    & + .aside + *,
+    & + .sidenote + * { margin-top: -0.5 * $hspacing; }
+  }
+
+}
+
+.post-header {
+  margin-top: $post-header-spacing;
+  margin-bottom: $post-header-spacing;
+}
+
+.post-cover {
+  margin-top: -$post-header-spacing + $spacing-unit;
+}
+
+.post-footer, #disqus_thread {
+  margin-top: $post-footer-spacing;
+  margin-bottom: $post-footer-spacing;
+}
+
+.page-link {
+  margin-right: 0.25em;
+}
+
+.site-footer {
+  margin-top: $post-footer-spacing;
+  margin-bottom: $spacing-unit;
+  vertical-align: middle;
+  text-align: justify;
+  -moz-text-align-last: center;
+  text-align-last: center;
+}
+
+.site-footer .wrapper::after {
+  display: inline-block;
+  content: '';
+  width: 100%;
+}
+
+.social-links {
+  display: inline-block;
+  text-align: center;
+  margin: 1em (-$content-padding);
+  padding: 0 0.3em;
+}
+
+.credits {
+  margin-left: -0.256em;
+  display: inline-block;
+}
+
+.post-list-item {
+  margin-top: $spacing-unit;
+  margin-bottom: $spacing-unit;
+}
+
+.post-description {
+  margin-top: 10px;
+  margin-bottom: 10px;
+}
+
+.cover-meta {
+  position: absolute;
+  bottom: 0;
+  right: 0;
+  margin: 4px 8px;
+  p { margin: 0; padding: 0; }
+}