jekyll-theme-kagami 0.1.12 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: eb08384ae23f21cbcaa55cd047831fb0f1d6b5d6
-  data.tar.gz: 051cd83887640fc3879fd88d2ad293fd5312e9d0
+SHA256:
+  metadata.gz: 19895b30a3f5482123635a2a024a0bc5a643d95dc76c0076f2d0a302436c62e5
+  data.tar.gz: 8f26714b5bb4ae0c9ebb56df2541eb9d4d3a673cc4a2ed7838c19e2a36446b68
 SHA512:
-  metadata.gz: 85de1f9a315b180f68f29b587e8e37495bff8debcb35a2e662ad74df78c5b48130dddecc3008b02555410f94237fd3a262ff74f152127db32c8c99970711cbbd
-  data.tar.gz: 26013bcd56eb8280be3263b877d624eefb6ef098caa2822219d6977a17ffbce0c2c13186893bcd9c10851883142d7e40de78f9277ccbd19c5115876563154e1c
+  metadata.gz: c1e2358a12f50e7fb89cd8fe8fb161eeda4363af06a5d7b565d8ac9ce9c2c18e6df581b98e8ca8fb950563ca0e5e18799c7cd4b8e02462bd13103abec6511cfb
+  data.tar.gz: d80d68bd36f4c1fd7b0daaf91e43c3060715c568240cdbd19286893317cc90608fbc63691484834e2a18070ad4008599697eb2bbdeaab7ff855f899647461d31

data/README.md

@@ -3,7 +3,7 @@
 [![Build Status](https://travis-ci.org/kamikat/jekyll-theme-kagami.svg?branch=master)](https://travis-ci.org/kamikat/jekyll-theme-kagami)
 [![Gem Version](https://badge.fury.io/rb/jekyll-theme-kagami.svg)](https://badge.fury.io/rb/jekyll-theme-kagami)
 
-A peaceful theme for Jekyll and GitHub Pages.
+Simple and clean theme for Jekyll and GitHub Pages.
 
 ![Screenshot](https://s2.banana.moe/docs/kagami-preview@2x.png)
 
@@ -66,11 +66,9 @@ Add the following lines to choose a color scheme:
 color_scheme: github
 ```
 
-### Enabling comments (via Disqus)
+### Comment service (Disqus or Gitalk)
 
-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:
+Add the following lines to your Jekyll site to enable Disqus comment service:
 
 ```yaml
 disqus_shortname: my_disqus_shortname
@@ -78,11 +76,23 @@ 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`
+For [Gitalk](https://github.com/gitalk/gitalk#options):
+
+```yaml
+gitalk:
+  id: <clientID>
+  secret: <clientSecret>
+  repo: <repo>
+  owner: <owner> # (optional) if not set, value of `github_username` will be used
+  admin: <admin> # (optional) if not set, value of `github_username` will be used
+  proxy: ...     # (optional)
+```
+
+By default, comment service will only be enabled in production mode, set an environment `JEKYLL_ENV=production` for local test.
 
-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.
+If you don't want to comments for particular posts you can disable that by adding `comments: false` to the post's YAML Front Matter.
 
-### Enabling Google Analytics
+### Google Analytics
 
 To enable Google Anaytics, add the following lines to your Jekyll site:
 
@@ -92,16 +102,15 @@ google_analytics: UA-NNNNNNNN-N
 
 Google Analytics will only appear in production, i.e., `JEKYLL_ENV=production`
 
-### Navigation
+### Navigation Bar
 
-Pages and posts can be listed as navigation item in header of pages. Add following frontmatter will make it
+Pages and posts can be registered as navigation item with following frontmatter:
 
 ```yaml
-navlevel: header
-navtitle: Awesome Title # optional, specifies the text to display on navigation item
+navbar_title: Awesome Title # specifies the text to display as navigation item
 ```
 
-Navigation items are ordered in alphabetical order by default in Jekyll. While you can adjust the order manually using
+Navigation items are ordered in alphabetical order by default in Jekyll. Adjust the order manually with a `position` value:
 
 ```yaml
 position: 999
@@ -109,7 +118,7 @@ position: 999
 
 ### Tags and category
 
-Layout file `post-list` supports filters by tag or category. Create pages with following frontmatter will generate a filtered post list.
+Layout file `post-list` supports filtering by tag or category. Create pages with following frontmatter will generate a filtered post list.
 
 ```yaml
 title: Title of Tag Page
@@ -130,7 +139,7 @@ Results from multiple filters are combined (logical 'or') into the result.
 
 A more flexible filter strategy is supported by supplying liquid expression to `by_expression` parameter in which post object can be referenced by the name `post`.
 
-### Enabling MathJax
+### MathJax
 
 You can use MathJax with Kramdown's [built-in support](https://kramdown.gettalong.org/syntax.html#math-blocks).
 
@@ -141,6 +150,17 @@ or post's front matter stuff:
 mathjax: true
 ```
 
+### Mermaid
+
+To enable [mermaid](https://mermaid-js.github.io/mermaid/), add following line to
+the site configuration or post's front matter stuff:
+
+```yaml
+mermaid: true
+```
+
+Code blocks with `mermaid` language tag should be transformed into diagrams.
+
 ### Use `.side-note` and `.retina2x`
 
 Taking advantages of [Block/span IAL](https://kramdown.gettalong.org/syntax.html#block-ials),
@@ -166,7 +186,7 @@ Bug reports and pull requests are welcome on GitHub at <https://github.com/kamik
 
 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.
+Your theme is setup just like a normal Jekyll site! To test your theme, run `bundle exec jekyll serve -s example` 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.
 

data/_includes/font-fix.html

@@ -0,0 +1,12 @@
+<script>
+  (function(elements) {
+    var elements = Array.prototype.slice.call(document.getElementsByClassName('baseline-fix'));
+    for (var i = 0; i != elements.length; i++) {
+      var el = elements[i];
+      el.innerHTML = el.innerHTML.replace(/[\u2000-\u206e⸀-\u2e7e⺀-\u2efe⼀-\u2fde⿰-\u2ffe\u3000-〾\u3040-ゞ゠-ヾ\u3100-\u312e\u3130-ㆎ㆐-㆞ㆠ-\u31be㇀-\u31eeㇰ-ㇾ㈀-㋾㌀-㏾㐀-\u4dbe一-\u9ffe\ua960-\ua97e가-\ud7ae\ud7b0-\ud7fe豈-\ufafe︰-﹎\uff00-￮]|[\ud840-\ud868\ud86a-\ud86c][\udc00-\udfff]|\ud82c[\udc00-\udcfe]|\ud869[\udc00-\udede\udf00-\udfff]|\ud86d[\udc00-\udf3e\udf40-\udfff]|\ud86e[\udc00-\udc1e]|\ud87e[\udc00-\ude1e]/g, function (ch) {
+        return '<span class="baseline-fix-block">' + ch + '<' + '/span>';
+      });
+      el.classList.remove('baseline-fix');
+    }
+  })(Array.prototype.slice.call(document.getElementsByClassName('baseline-fix')));
+</script>

data/_includes/gitalk.html

@@ -0,0 +1,18 @@
+<div id="gitalk-container"></div>
+<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/gitalk@1/dist/gitalk.css">
+<script src="https://cdn.jsdelivr.net/npm/gitalk@1/dist/gitalk.min.js"></script>
+<script>
+    var gitalk = new Gitalk({
+        id: '{{ page.title }}',
+        clientID: '{{ site.gitalk.id }}',
+        clientSecret: '{{ site.gitalk.secret }}',
+        repo: '{{ site.gitalk.repo | default: site.gitalk.repository }}',
+        owner: '{{ site.gitalk.owner | default: site.github_username }}',
+        admin: ['{{ site.gitalk.admin | default: site.github_username }}'],
+        body: location.href,
+        proxy: '{{ site.gitalk.proxy | default: "https://cors-anywhere.azm.workers.dev/https://github.com/login/oauth/access_token" }}',
+        language: '{{ site.lang | default: "en" }}',
+        distractionFreeMode: false
+    })
+    gitalk.render('gitalk-container')
+</script>

data/_includes/header.html

@@ -1,6 +1,6 @@
 <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>
+  <h1 class="post-title baseline-fix" itemprop="name headline">{{ page.title | escape | replace: "​", "<wbr>" }}</h1>
 </header>
 
 {% if page.cover_url %}

data/_includes/mermaid.html

@@ -0,0 +1,14 @@
+<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js"></script>
+<script type="text/javascript">
+  (function () {
+    mermaid.init({ startOnLoad: true }, "pre code.language-mermaid", function () {
+      const codeBlock = document.querySelector('code.language-mermaid');
+      codeBlock.style.backgroundColor = 'initial';
+
+      const preBlock = codeBlock.parentNode;
+      preBlock.style.border = 'none';
+      preBlock.style.textAlign = 'center';
+      preBlock.style.backgroundColor = 'initial';
+    });
+  })();
+</script>

data/_includes/site-nav.html

@@ -1,6 +1,8 @@
 <nav class="site-nav">
-  {% assign sorted_pages = site.pages | where_exp: "page", "page.navlevel == 'header'" | sort: "position" %}
-  {% for my_page in sorted_pages %}
-  <a class="page-link" href="{{ my_page.url | relative_url }}" >{{ my_page.navtitle | default: my_page.title | escape }}</a>
+  {% assign sorted_pages = site.pages | sort: "position" %}
+  {% for _page in sorted_pages %}
+  {% if _page.navbar_title or _page.navtitle or _page.navlevel == "header" or _page.navbar %}
+  <a class="page-link" href="{{ _page.url | relative_url }}" >{{ _page.navbar_title | default: _page.navtitle | default: _page.title | escape }}</a>
+  {% endif %}
   {% endfor %}
 </nav>

data/_layouts/default.html

@@ -9,8 +9,13 @@ layout: blank
       {{ content }}
     </div>
     {% include retina-image.html %}
+    {% if site.mermaid or page.mermaid %}
+    {% include mermaid.html %}
+    {% endif %}
   </main>
 
   {% include footer.html %}
 
+  {% include font-fix.html %}
+
 </body>

data/_layouts/post-list.html

@@ -30,24 +30,29 @@ layout: default
   {% endif %}
   {% for post in 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>
+    {% if post.cover_url %}
+    <div class="post-item-cover" style="background-image: url('{{ post.cover_url }}')"></div>
     {% 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 %}
+    <div class="post-item-label">
+      <a class="post-item-link baseline-fix" 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 %}
-      {% unless words contains "-" %}
-      {{ words | plus: 250 | divided_by: 250 | append: " minute read"  }}
-      {% endunless %}
+      <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>
     </div>
   </li>
   {% endfor %}

data/_layouts/post.html

@@ -25,7 +25,12 @@ layout: default
     {% endif %}
   </footer>
 
-  {% if jekyll.environment == 'production' and site.disqus_shortname and page.comments != false %}
+  {% if jekyll.environment == 'production' and page.comments != false %}
+  {% if site.disqus_shortname %}
   {% include disqus.html %}
+  {% elsif site.gitalk %}
+  {% include gitalk.html %}
   {% endif %}
+  {% endif %}
+
 </article>

data/_sass/kagami/_layout.scss

@@ -41,7 +41,16 @@ article {
     margin-bottom: 0;
   }
 
-  .highlight {
+  .task-list-item {
+    list-style-type: none;
+  }
+
+  .task-list-item-checkbox {
+    margin: 0 .5em .3em -1.6em;
+    vertical-align: middle;
+  }
+
+  pre {
     position: relative;
     overflow: hidden;
 
@@ -50,11 +59,11 @@ article {
       overflow-x: auto;
     }
 
-    @include exdent-horizontally($hspacing);
-    @include exdent-vertically(0.5 * $vspacing);
+    @include exdent-horizontally($hspacing, "code");
+    @include exdent-vertically(0.5 * $vspacing, "code");
 
     @media screen and (min-width: $content-width) {
-      @include exdent-horizontally(2 * $hspacing);
+      @include exdent-horizontally(2 * $hspacing, "code");
     }
   }
 
@@ -166,10 +175,26 @@ article {
 }
 
 .post-list-item {
+  position: relative;
   margin-top: $spacing-unit;
   margin-bottom: $spacing-unit;
 }
 
+.post-item-cover {
+  width: 100vw;
+  position: absolute;
+  top: -.5 * $spacing-unit;
+  bottom: -.5 * $spacing-unit;
+  margin-left: 50%;
+  transform: translateX(-50%);
+  background-size: cover;
+  background-position: center;
+}
+
+.post-item-label {
+  position: relative;
+}
+
 .post-description {
   margin-top: 10px;
   margin-bottom: 10px;

data/_sass/kagami/_typography.scss

@@ -96,8 +96,6 @@ article {
     color: lighten($content-color, 20%);
     background: $block-code-background;
     code {
-      margin: 0;
-      padding: 0;
       color: inherit;
       background: none;
       line-height: 1.6;
@@ -225,6 +223,16 @@ article {
   color: lighten($content-color, 40%);
 }
 
+.post-list-item .post-item-cover {
+  opacity: 0.03;
+  transition: opacity 0.5s ease-out;
+}
+
+.post-list-item:hover .post-item-cover {
+  opacity: 0.15;
+  transition: opacity 0.5s ease-out;
+}
+
 .cover-meta {
   font-family: "Press Start 2P", cursive;
   font-variant-caps: all-petite-caps;
@@ -245,3 +253,12 @@ article {
   h3 { margin-left: -2px; }
 }
 
+.baseline-fix {
+  visibility: hidden;
+}
+
+.baseline-fix-block {
+  display: inline-block;
+  vertical-align: top;
+  font-size: 0.95em;
+}

data/_sass/kagami/_utility.scss

@@ -1,16 +1,16 @@
-@mixin exdent-horizontally($size) {
+@mixin exdent-horizontally($size, $selector: "*") {
   margin-left: -$size;
   margin-right: -$size;
-  & > * {
+  & > #{$selector} {
     padding-left: $size;
     padding-right: $size;
   }
 }
 
-@mixin exdent-vertically($size) {
+@mixin exdent-vertically($size, $selector: "*") {
   margin-top: -$size;
   margin-bottom: -$size;
-  & > * {
+  & > #{$selector} {
     padding-top: $size;
     padding-bottom: $size;
   }

metadata

@@ -1,58 +1,30 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-theme-kagami
 version: !ruby/object:Gem::Version
-  version: 0.1.12
+  version: 0.2.0
 platform: ruby
 authors:
 - kamikat
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-12-03 00:00:00.000000000 Z
+date: 2021-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: jekyll
+  name: github-pages
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.3'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.3'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.12'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.12'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
-description: 
+        version: '0'
+description:
 email:
 - kamikat@banana.moe
 executables: []
@@ -62,10 +34,13 @@ files:
 - LICENSE.txt
 - README.md
 - _includes/disqus.html
+- _includes/font-fix.html
 - _includes/footer.html
+- _includes/gitalk.html
 - _includes/google-analytics.html
 - _includes/head.html
 - _includes/header.html
+- _includes/mermaid.html
 - _includes/retina-image.html
 - _includes/site-nav.html
 - _layouts/blank.html
@@ -116,7 +91,7 @@ homepage: https://github.com/kamikat/jekyll-theme-kagami
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -131,9 +106,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: A peaceful theme for Jekyll and GitHub Pages.
 test_files: []