chungking 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9f641f828314b6aad332546fec8f53cbbabad79dfa4175dd58a2211724e8e85e
+  data.tar.gz: 57db0f99233c927937243e98e3711ffd4e8e8903bf13001d9b6a1108a35653f8
+SHA512:
+  metadata.gz: 84da3c082d3dfcc40a1ed8de9e00a67bce4003f4a5e4b9969fc627a023b2604a416069428061be7430ced9fbef357ec7b63e385cde7af09105c17950db33ff46
+  data.tar.gz: 235bcb69848277496da7e58699317aea19e92055fe642eabfd77283264a0d6b168c555668a9b569e070c88fd24172e6f5412c226c04df664acc04e743f5cb804

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 mmdlow
+
+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,101 @@
+# chungking
+
+Chungking is a modern, elegant Jekyll theme with a focus on clear yet stylish content delivery. If you're looking to do some heavy blogging or article writing, Chungking is for you.
+
+## Features
+
+#### Featured post carousel
+
+Show off the best posts on your site via an image carousel on the main page. Any post with the `featured: true` property set in the front matter will automatically be added to the carousel.
+
+#### Table of contents
+
+For long posts with multiple sections, generate a table of contents corresponding to the markdown headers in your text. It's as simple as setting `toc: true` in your front matter.
+
+#### Mobile-ready
+
+Chungking's responsive design ensures smooth scaling across devices with different screen sizes.
+
+## Configuration
+
+#### Posts
+
+Possible front matter configuration for posts:
+
+```
+---
+layout: post
+title: My Post
+blurb: A short description of the post. Truncates at 25 words.
+image: /path/to/post/cover/image.jpg
+# images typically go in the assets/images folder
+
+featured: true
+# Adds this post to the featured carousel on the home page
+
+toc: true
+# Generates a table of contents for the current post, based on the markdown header # tags in the text
+---
+
+My text...
+```
+
+#### Pages
+
+New pages added in the `_pages` directory are automatically added to the header nav menu.
+
+Page front matter configuration is similar to Post front matter, excluding the `blurb` and `featured` properties.
+
+## Installation
+
+#### Via Fork
+
+Fork this repository, then add your own content.
+
+#### Via Ruby Gems
+
+Add these lines to your Jekyll site's `Gemfile`:
+
+```ruby
+group :jekyll_plugins do
+    gem "jekyll-paginate"
+end
+
+gem "chungking"
+```
+
+Note that Chungking requires the **jekyll-paginate** gem to display posts properly.
+
+And add these lines to your Jekyll site's `_config.yml`:
+
+```yaml
+theme: chungking
+
+plugins:
+  - jekyll-paginate
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install chungking
+
+## Contributing
+
+Bug reports and pull requests are welcome on [GitHub](https://github.com/mmdlow/chungking). 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`, `_sass` and `assets` tracked with Git will be bundled.
+To add a custom directory to your theme-gem, please edit the regexp in `chungking.gemspec` accordingly.
+
+## License
+
+The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/_includes/carousel.html

@@ -0,0 +1,40 @@
+<div class="content mx-auto p-3 carousel">
+  {% assign featured_posts = site.posts | where: "featured", true %}
+
+  {% for post in featured_posts %}
+  {% if forloop.first %}
+  <div class="carousel-slide active" style="background-image: url('{{ post.image | prepend: site.baseurl }}');">
+    <div class="col-4 p-4 carousel-card">
+      <h2 class="pb-4">
+        <a href="{{ post.url | prepend: site.baseurl }}">{{ post.title | truncate: 35 }}</a>
+      </h2>
+      <div class="col-4 border-top-thick"></div>
+      <h6 class="py-4 mb-4">{{ post.date | date: '%d %b %Y' }}</h6>
+    </div>
+  </div>
+  {% else %}
+  <div class="carousel-slide" style="background-image: url('{{ post.image | prepend: site.baseurl }}');">
+    <div class="col-4 p-4 carousel-card">
+      <h2 class="pb-4">
+        <a href="{{ post.url | prepend: site.baseurl }}">{{ post.title | truncate: 35 }}</a>
+      </h2>
+      <div class="col-4 border-top-thick"></div>
+      <h6 class="py-4 mb-4">{{ post.date | date: '%d %b %Y' }}</h6>
+    </div>
+  </div>
+  {% endif %}
+  {% endfor %}
+
+  {% if featured_posts.size > 1 %}
+  <div class="col-4 px-4 flex space-between carousel-navigation">
+    <div class="col-3 carousel-btn btn-prev border-left-thick">
+      <h5 class="ml-3">Previous</h5>
+    </div>
+    <div class="col-3 carousel-btn btn-next border-right-thick text-right">
+      <h5 class="mr-3">Next</h5>
+    </div>
+  </div>
+  {% endif %}
+</div>
+
+<script src="{{ site.baseurl }}/assets/js/carousel.js"></script>

data/_includes/footer.html

@@ -0,0 +1,30 @@
+<div class="p-3 footer-nav">
+  <div class="width-lg-stretch pt-3 content mx-auto flex space-between border-top">
+    <div class="my-2 align-items-center">
+      <a class="header-brand" href="{{ site.baseurl }}/">{{ site.title }}</a>
+      <span class="small ml-2">copyright © 2020. created by {{ site.author }}</span>
+    </div>
+    <div class="my-2">
+      {% if site.instagram %}
+      <a class="mr-3 ml-lg-3 mr-lg-0" href="{{ site.instagram }}">
+        <div data-icon="ei-sc-instagram" data-size="s"></div>
+      </a>
+      {% endif %}
+      {% if site.twitter %}
+      <a class="mr-3 ml-lg-3 mr-lg-0" href="{{ site.twitter }}">
+        <div data-icon="ei-sc-twitter" data-size="s"></div>
+      </a>
+      {% endif %}
+      {% if site.facebook %}
+      <a class="mr-3 ml-lg-3 mr-lg-0" href="{{ site.facebook }}">
+        <div data-icon="ei-sc-facebook" data-size="s"></div>
+      </a>
+      {% endif %}
+      {% if site.github %}
+      <a class="mr-3 ml-lg-3 mr-lg-0" href="{{ site.github }}">
+        <div data-icon="ei-sc-github" data-size="s"></div>
+      </a>
+      {% endif %}
+    </div>
+  </div>
+</div>

data/_includes/head.html

@@ -0,0 +1,22 @@
+<head>
+  <meta charset="utf-8">
+  <meta http-equiv="X-UA-Compatible" content="IE=edge">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <meta name=:author" content="{{ site.author }}">
+  <meta name="description"
+    content="{{ page.excerpt | default: site.description | strip_html | strip_newlines | normalize_whitespace | truncate: 160 | escape }}">
+
+  <title>{% if page.title %}{{ page.title | escape }}{% else %}{{ site.title | escape }}{% endif %}</title>
+
+  {% assign user_url = site.url | append: site.baseurl %}
+  {% assign full_base_url = user_url | default: site.github.url %}
+  <link rel="canonical" href="{{ page.url | replace:'index.html','' | prepend: site.baseurl | prepend: site.url }}">
+  <link rel="alternate" type="application/rss+xml" title="{{ site.title }}"
+    href="{{ '/feed.xml' | prepend: site.baseurl | prepend: site.url }}">
+  <link href="https://fonts.googleapis.com/css?family=Archivo:400,400i,700&display=swap" rel="stylesheet">
+  <link href="https://fonts.googleapis.com/css?family=Anonymous+Pro:400,700&display=swap" rel="stylesheet">
+  <link rel="stylesheet" href="{{ '/assets/styles.css' | prepend: full_base_url }}">
+  <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/evil-icons@1.9.0/assets/evil-icons.min.css">
+  <script src="https://cdn.jsdelivr.net/npm/evil-icons@1.9.0/assets/evil-icons.min.js"></script>
+
+</head>

data/_includes/header.html

@@ -0,0 +1,19 @@
+<header class="py-2 header-nav">
+  <div class="width-lg-stretch px-3 content mx-auto flex space-between">
+    <div class="my-2 flex space-between">
+      <a class="header-brand" href="{{ site.baseurl }}/">{{ site.title }}</a>
+      <a class="header-menu-btn">
+        <div data-icon="ei-navicon" data-size="s"></div>
+      </a>
+    </div>
+    <div class="my-2 header-menu-lg-stretch">
+      {% for page in site.html_pages %}
+      {% unless page.title == 'Home' %}
+      <a class="header-link mr-2 ml-lg-2 mr-lg-0" href="{{ page.url | prepend: site.baseurl }}">{{ page.title }}</a>
+      {% endunless %}
+      {% endfor %}
+    </div>
+  </div>
+</header>
+
+<script src="{{ site.baseurl }}/assets/js/header.js"></script>

data/_includes/post-navigation.html

@@ -0,0 +1,22 @@
+<div class="flex space-between">
+  {% if page.previous.url %}
+  <div class="col-3 border-left-thick">
+    <a href="{{ page.previous.url | prepend: site.baseurl }}">
+      <h5 class="ml-3 mb-1">Previous</h5>
+      <span class="ml-3">{{ page.previous.title }}</span>
+    </a>
+  </div>
+  {% else %}
+  <div class="col-3"></div>
+  {% endif %}
+  {% if page.next.url %}
+  <div class="col-3 border-right-thick text-right">
+    <a href="{{ page.next.url | prepend: site.baseurl }}">
+      <h5 class="mb-1 mr-3">Next</h5>
+      <span class="mr-3">{{ page.next.title }}</span>
+    </a c>
+  </div>
+  {% else %}
+  <div class="col-3"></div>
+  {% endif %}
+</div>

data/_includes/toc.html

@@ -0,0 +1,11 @@
+<div class="col-2">
+  {% if page.toc %}
+  <div class="toc pr-2">
+    <h4 class="pb-3 toc-title">Contents</h4>
+    <div class="contents"></div>
+  </div>
+  {% endif %}
+</div>
+
+<script src="https://unpkg.com/scrollnav@3.0.1/dist/scrollnav.min.umd.js"></script>
+<script src="{{ site.baseurl }}/assets/js/toc.js"></script>

data/_layouts/default.html

@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html>
+{% include head.html %}
+
+<body>
+  {% include header.html %}
+  {{ content }}
+  {% include footer.html %}
+</body>
+
+</html>

data/_layouts/home.html

@@ -0,0 +1,58 @@
+---
+layout: default
+---
+
+<div class="content-wrapper">
+  {% include carousel.html %}
+  <div class="content mx-auto p-3">
+    {% for post in paginator.posts %}
+    <div class="width-lg-stretch py-4 flex space-between postcard">
+      <div class="full-width">
+        <h3 class="mb-3">
+          <a href="{{ post.url | prepend: site.baseurl }}">{{ post.title }}</a>
+        </h3>
+        <div class="my-2 col-1 border-bottom-thick"></div>
+
+        {% if post.blurb %}
+        <p class="my-3">{{ post.blurb | truncatewords:25 }}</p>
+        {% else %}
+        <p class="my-3">{{ post.content | strip_html | truncatewords:40 }}</p>
+        {% endif %}
+
+        <span class="mb-3 bold secondary">{{ post.date | date: '%d %b %Y' }}</span>
+      </div>
+      <div class="mr-2 ml-lg-2 mr-lg-0 flex align-center">
+        {% if post.image %}
+        <a href="{{ post.url | prepend: site.baseurl }}">
+          <img class="image-thumbnail image-lg-stretch" src="{{ post.image | prepend: site.baseurl }}"></a>
+        {% endif %}</div>
+    </div>
+    {% endfor %}
+
+    {% if paginator.total_pages > 1 %}
+    <div class="mt-4 flex space-between">
+      {% if paginator.previous_page %}
+      <div class="border-left-thick">
+        <a href="{{ paginator.previous_page_path | prepend: site.baseurl }}">
+          <h5 class="ml-3">newer posts</h5>
+        </a>
+      </div>
+      {% else %}
+      <div class="col-1"></div>
+      {% endif %}
+
+      <h5>page {{ paginator.page }} of {{ paginator.total_pages }}</h5>
+
+      {% if paginator.next_page %}
+      <div class="border-right-thick text-right">
+        <a href="{{ paginator.next_page_path | prepend: site.baseurl }}">
+          <h5 class="mr-3">older posts</h5>
+        </a>
+      </div>
+      {% else %}
+      <div class="col-1"></div>
+      {% endif %}
+    </div>
+    {% endif %}
+  </div>
+</div>

data/_layouts/page.html

@@ -0,0 +1,22 @@
+---
+layout: default
+---
+<div class="content-wrapper">
+  <div class="content mx-auto p-3">
+    <div class="py-4">
+      <h1 class="col-4 mb-4">{{ page.title }}</h1>
+      <div class="col-2 mb-4 pb-4 border-top-thick"></div>
+
+      {% if page.image %}
+      <img class="image-post" src="{{ page.image | prepend: site.baseurl }}"></a>
+      {% endif %}
+
+      <div class="flex py-4 my-4">
+        {% include toc.html %}
+        <div class="col-6 px-3 width-lg-stretch border-left">
+          <div class="prose">{{ content }}</div>
+        </div>
+      </div>
+    </div>
+  </div>
+</div>

data/_layouts/post.html

@@ -0,0 +1,29 @@
+---
+layout: default
+---
+<div class="content-wrapper">
+  <div class="content mx-auto p-3">
+    <div class="py-4">
+      <h1 class="col-4 mb-4">{{ page.title }}</h1>
+      <div class="col-2 border-top-thick"></div>
+      <div class="my-4 pb-4">
+        {% if page.blurb %}
+        <p class="mb-3">{{ page.blurb }}</p>
+        {% endif %}
+        <h5 class="secondary">{{ page.date | date: '%d %b %Y' }}</h5>
+      </div>
+      {% if page.image %}
+      <img class="image-post" src="{{ page.image | prepend: site.baseurl }}"></a>
+      {% endif %}
+      <div class="flex py-4 my-4">
+        {% include toc.html %}
+        <div class="col-6 px-3 width-lg-stretch border-left">
+          <div class="prose">{{ content }}</div>
+          <div class="mt-4 pt-4">
+            {% include post-navigation.html %}
+          </div>
+        </div>
+      </div>
+    </div>
+  </div>
+</div>

data/_sass/_base.scss

@@ -0,0 +1,25 @@
+* {
+    box-sizing: border-box !important;
+  }
+  
+body, h1, h2, h3, h4, h5, h6, p, ol, ul, figure, hr, blockquote, dl, dd, dt, pre, figure {
+padding: 0;
+margin: 0;
+}
+
+a {
+text-decoration: none;
+color: $color-black;
+}
+
+body {
+font-family: $font-family-sans-serif;
+font-size: $font-size;
+}
+
+h1 { font-size: $h1-size; }
+h2 { font-size: $h2-size; }
+h3 { font-size: $h3-size; }
+h4 { font-size: $h4-size; }
+h5 { font-size: $h5-size; }
+h6 { font-size: $h6-size; }

data/_sass/_components.scss

@@ -0,0 +1,220 @@
+@import "variables";
+
+/* Header */
+.header {
+  &-brand {
+    font-weight: bold !important;
+    color: $color-dark-gray;
+  }
+
+  &-link {
+    font-weight: bold !important;
+    color: $color-black;
+    text-decoration: none !important;
+    display: inline-block;
+
+    &:after {
+      content: "";
+      display: flex;
+      margin: 0 auto;
+      height: $border-weight;
+      background: $color-black;
+      transition: width $transition-time ease 0s;
+      width: 0;
+      position: relative;
+      top: $space-1;
+    }
+
+    &:hover:after {
+      width: 100%;
+    }
+  }
+
+  &-nav {
+    position: fixed;
+    width: 100%;
+    transition: transform $transition-time ease 0s;
+    z-index: 100;
+    background-color: $header-color;
+
+    &.hide {
+      transform: translateY(-100%);
+    }
+
+    &.reveal {
+      transform: none;
+      border-bottom: $border-weight solid $color-black;
+    }
+
+    .header-menu-btn {
+      display: none;
+      cursor: pointer;
+    }
+
+    @media(max-width: $breakpoint-lg) {
+      .header-menu-lg-stretch {
+        display: none;
+
+        &.reveal {
+          display: block;
+        }
+      }
+
+      .header-menu-btn {
+        display: block;
+      }
+    }
+  }
+}
+
+/* Footer */
+.footer {
+
+  &-nav {
+    top: $header-height;
+    position: relative;
+  }
+}
+
+/* Carousel */
+.carousel {
+  position: relative;
+  color: $color-white;
+
+  a {
+    color: $color-white;
+  }
+
+  &-card {
+    height: inherit;
+    border-radius: $border-radius;
+    background-color: rgba($color: $color-black, $alpha: 0.6);
+    transition: width $transition-time;
+
+    @media (max-width: $breakpoint-lg) {
+      width: 100% !important;
+    }
+
+    @media (max-width: $breakpoint-sm) {
+      h2 {
+        font-size: $h3-size;
+      }
+    }
+  }
+
+  &-slide {
+    height: $carousel-height;
+    border-radius: $border-radius;
+    background-color: $color-light-gray;
+    background-size: cover;
+    opacity: 0;
+    z-index: 1;
+    position: absolute;
+    top: $space-3;
+    left: $space-3;
+    right: $space-3;
+    transition: opacity $transition-time;
+
+    &.active {
+      opacity: 1;
+      z-index: 2;
+      position: relative;
+      top: 0;
+      left: 0;
+      right: 0;
+    }
+  }
+
+  &-navigation {
+    z-index: 3;
+    position: relative;
+    width: 100%;
+    top: -$space-4 * 1.5;
+  }
+
+  &-btn {
+    cursor: pointer;
+  }
+}
+
+/* Evil Icons */
+.icon {
+  fill: $color-black !important;
+}
+
+/* Images */
+img.image {
+  &-thumbnail {
+    width: $img-width-sm;
+    height: $img-height-sm;
+    object-fit: cover;
+    border-radius: $border-radius;
+  }
+
+  &-post {
+    width: 100%;
+    border-radius: $border-radius;
+  }
+}
+
+/* Home page postcard */
+.postcard {
+
+  @media(max-width: $breakpoint-lg) {
+    img.image-lg-stretch {
+      display: block !important;
+      width: 100%;
+      height: 100%;
+      margin-top: 1em;
+    }
+  }
+}
+
+/* Post and page table of contents */
+.toc {
+  position: sticky;
+  top: $space-4 * 2;
+  overflow-y: auto;
+  max-height: calc(100vh - #{$content-height-offset});
+
+  @media(max-width: $breakpoint-lg) {
+    display: none;
+  }
+
+  .scroll-nav {
+
+    .scroll-nav__item {
+      padding-left: $space-3;
+      font-size: $post-font-size;
+    }
+
+    .scroll-nav__sub-item {
+      font-size: $font-size;
+    }
+
+    .scroll-nav__item, .scroll-nav__sub-item {
+
+      &--active::before {
+        left: 0;
+        border-left: $border-weight * 2 solid $color-black;
+        content: "";
+        display: block;
+        position: absolute;
+        height: 1em;
+      }
+    }
+
+    li {
+      margin-bottom: 1em;
+      list-style-type: none;
+
+      ol {
+        margin-top: 1em;
+
+        li {
+          margin-bottom: 0.5em;
+        }
+      }
+    }
+  }
+}