pole 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 592df8fdb3c7dae642995e3160447f15cc8335cd73b510178736d752a36e551a
+  data.tar.gz: 3abb02d0764259dbb4b4e2267efe8faabb1b13f3dd8ca302af4cebd06fec8e38
+SHA512:
+  metadata.gz: 7236baae3fb0bcd992a1be5d12382af1182dc9efb96660dbf1501f7aeb7bc0a3b75ee6b090a857327453e088f1a96f96ed2b9c9570d22a53608688c8dddec0e5
+  data.tar.gz: b76c45f6bd484eb5f9f7e28c824ad70423468643a5d22aee94753881dffc653e23b8c46fd36ae1a2f05bbca90293cc9b5f8c9b1f587c5b50ffac91b9e217fbaa

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 szivong
+
+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,190 @@
+# Pole <!-- omit in toc -->
+
+Pole is *a one-column minimal responsive Jekyll blog theme*.
+
+One of the purposes of Pole is to be an alternative option to the default theme of Jekyll -- [Minima](https://github.com/jekyll/minima). Pole is still keeping minimal, but meanwhile, more beautiful and mellow, and doesn't lose some useful basic features, such as archive.
+
+Check the *[live demo](https://szivong.io/pole/)*.
+
+![Screenshot Light](screenshot-light.png)
+![Screenshot Dark](screenshot-dark.png)
+
+## Highlight Features <!-- omit in toc -->
+
+- [Normalize.css](https://github.com/necolas/normalize.css)
+- [Open Color](https://github.com/yeun/open-color)
+- [Font Awesome](https://fontawesome.com/)
+- [Disqus](https://disqus.com/)
+- [MathJax](https://www.mathjax.org/)
+- [Google Analytics 4](https://support.google.com/analytics/answer/10089681?hl=en)
+- [Jekyll Feed](https://github.com/jekyll/jekyll-feed/)
+- [Jekyll Paginate](https://github.com/jekyll/jekyll-paginate)
+- [Jekyll SEO Tag](https://github.com/jekyll/jekyll-seo-tag/)
+- Related posts (time-based, because Jekyll) below each post
+- Dark mode, via [`prefers-color-scheme`](https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-color-scheme)
+- Archive implemented by pure [Liquid](https://shopify.github.io/liquid/)
+
+## Table of Contents <!-- omit in toc -->
+
+- [Installation](#installation)
+- [Usage](#usage)
+  - [Global Configuration](#global-configuration)
+  - [Post Configuration](#post-configuration)
+  - [Homepage](#homepage)
+  - [Custom Head](#custom-head)
+  - [Navigation](#navigation)
+  - [Social Links](#social-links)
+  - [Alert Messages](#alert-messages)
+  - [Google Analytics 4](#google-analytics-4)
+  - [Archive](#archive)
+- [Contributing](#contributing)
+- [Development](#development)
+- [License](#license)
+
+## Installation
+
+Add this line to your Jekyll site's `Gemfile`:
+
+```ruby
+gem "pole"
+```
+
+And add this line to your Jekyll site's `_config.yml`:
+
+```yaml
+theme: pole
+```
+
+And then execute:
+
+```shell
+bundle
+```
+
+Or install it yourself as:
+
+```shell
+gem install pole
+```
+
+You can also install the latest code via [`jekyll-remote-theme`](https://github.com/benbalter/jekyll-remote-theme):
+
+1. Add this line to your Jekyll site's `Gemfile`:
+
+    ```ruby
+    gem "jekyll-remote-theme"
+    ```
+
+2. Add these lines to your Jekyll site's `_config.yml`:
+
+    ```ruby
+    plugins:
+      - jekyll-remote-theme
+
+    remote_theme: szivong/pole@main
+    ```
+
+## Usage
+
+### Global Configuration
+
+| Variable | Type | Default | Specification |
+| -------- | ---- | ------- | ------------- |
+| `title` | String | --- | The title of the website |
+| `tagline` | String | --- | The tagline of the website |
+| `lang` | String | `en` | The language of pages; The value can be overwritten by the `lang` variable on each page |
+| `author.name` | String | --- | The name of the website author |
+| `author.url` | String | --- | A URL of the website author |
+| `tags_path` | String | --- | A path to the archive-by-tags page; It is used by tags on each post |
+| `categories_path` | String | --- | A path to the archive-by-categories page; It is used by categories on each post |
+| `disqus` | String | --- | Disqus short name |
+| `google_analytics` | String | --- | Google Analytics 4 Measurement ID |
+
+### Post Configuration
+
+| Variable | Type | Default | Specification |
+| -------- | ---- | ------- | ------------- |
+| `description` | String | --- | A description of the current post |
+| `last_modified_at` | String | --- | The date of the last modification you made on a post after its publishing |
+| `author` | String or Array | --- | The author name(s) of the post |
+| `comments` | Boolean | `true` | Does enable the Disqus comment system |
+| `math` | Boolean | `false` | Does enable MathJax on this page |
+
+### Homepage
+
+You can create a homepage for your blog by setting `layout: home` in your `index.html`.
+
+### Custom Head
+
+Pole leaves a placeholder to allow defining custom head. All you need to do is putting data into `_includes/custom-head.html`, and they would be automatically included in `<head>`.
+
+### Navigation
+
+The navigation bar of Pole is configurable. You just need to specify titles and URLs in the file `_data/navigation.yml`, for example,
+
+```yml
+- title: About
+  url: /about/
+- title: Archive
+  url: /archive/
+- title: Categories
+  url: /categories/
+```
+
+### Social Links
+
+Pole allows you to show social links on the website. All you need to do is creating a file `_data/social.yml`, for example,
+
+```yml
+- title: Email
+  url: mailto:szivong@gmail.com
+  icon: fas fa-envelope
+- title: Twitter
+  url: https://twitter.com/szivong
+  icon: fab fa-twitter
+- title: GitHub
+  url: https://github.com/szivong
+  icon: fab fa-github
+```
+
+### Alert Messages
+
+Pole provides some predefined classes to specify different levels of **alert messages**. In order of tone from light to heavy, they are: `message-info`, `message-warning`, and `message-danger`. You may add it to single elements like a `<p>`, or to a parent if there are multiple elements to show.
+
+### Google Analytics 4
+
+To enable [Google Analytics 4](https://support.google.com/analytics/answer/10089681?hl=en), you just need to set the [Measurement ID](https://support.google.com/analytics/answer/7372977?hl=en) in your `_config.yml`, for example,
+
+```yml
+google_analytics: G-XXXXXXX
+```
+
+### Archive
+
+Pole provides some built-in archive pages. It is implemented in pure Liquid. If you want to archive posts by years, you can create a page and put these code in it:
+
+```yml
+---
+layout: archive
+type: years
+---
+```
+
+Similarly, if you want to archive posts by categories or tags, you can set the `type` property as `categories` or `tags`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [https://github.com/szivong/pole](https://github.com/szivong/pole). 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 `pole.gemspec` accordingly.
+
+## License
+
+The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/_includes/archive-by-tagories.html

@@ -0,0 +1,71 @@
+{%- if page.type == 'categories' -%}
+  {%- assign taxonomies = site.categories -%}
+{%- elsif page.type == 'tags' -%}
+  {%- assign taxonomies = site.tags -%}
+{%- else -%}
+  {%- assign taxonomies = none -%}
+{%- endif -%}
+
+{%- assign max_count = 0 -%}
+{%- for taxonomy in taxonomies -%}
+  {%- assign posts = taxonomy[1] -%}
+  {%- if posts.size > max_count -%}
+    {%- assign max_count = posts.size -%}
+  {%- endif -%}
+{%- endfor -%}
+
+<div class="taxonomies-wrapper">
+  <ul class="taxonomies">
+    {%- for i in (1..max_count) reversed -%}
+      {%- for taxonomy in taxonomies -%}
+        {%- assign taxonomy_name = taxonomy[0] -%}
+        {%- assign slugified_taxonomy_name = taxonomy_name | slugify -%}
+        {%- assign posts = taxonomy[1] -%}
+        {%- if posts.size == i -%}
+          <li>
+            {%- capture link -%}{{ page.permalink }}#{{ slugified_taxonomy_name }}{%- endcapture -%}
+            <a class="taxonomy" href="{{ link | relative_url }}">
+              <span>
+                {%- if page.type == 'tags' -%}
+                  {{ slugified_taxonomy_name }}
+                {%- else -%}
+                  {{ taxonomy_name }}
+                {%- endif -%}
+              </span>
+              <span class="taxonomy-count">{{ posts.size }}</span>
+            </a>
+          </li>
+        {%- endif -%}
+      {%- endfor -%}
+    {%- endfor -%}
+  </ul>
+</div>
+
+{%- for i in (1..max_count) reversed -%}
+  {%- for taxonomy in taxonomies -%}
+    {%- assign taxonomy_name = taxonomy[0] -%}
+    {%- assign slugified_taxonomy_name = taxonomy_name | slugify -%}
+    {%- assign posts = taxonomy[1] -%}
+    {%- if posts.size == i -%}
+      <h2 id="{{ slugified_taxonomy_name }}">
+        {%- if page.type == 'tags' -%}
+          {{ slugified_taxonomy_name }}
+        {%- else -%}
+          {{ taxonomy_name }}
+        {%- endif -%}
+      </h2>
+      <ul class="post-list-by-taxonomy">
+        {%- for post in posts -%}
+          <li>
+            <time datetime="{{ page.date | date_to_xmlschema }}">{{ post.date | date: "%Y-%m-%d" }}</time> 
+            &raquo; 
+            <a href="{{ post.url | relative_url }}">{{ post.title | escape }}</a>
+          </li>
+        {%- endfor -%}
+      </ul>
+      <a href="#" onclick="backToTop()" class="back-to-top">Top &#8648;</a>
+    {%- endif -%}
+  {%- endfor -%}
+{%- endfor -%}
+
+{% include back-to-top.html %}

data/_includes/archive-by-years.html

@@ -0,0 +1,32 @@
+{% assign taxonomies = site.posts | group_by_exp: "post", "post.date | date: '%Y'" %}
+
+<div class="taxonomies-wrapper">
+  <ul class="taxonomies">
+    {%- for taxonomy in taxonomies -%}
+      <li>
+        {%- capture link -%}{{ page.permalink }}#{{ taxonomy.name }}{%- endcapture -%}
+        <a class="taxonomy" href="{{ link | relative_url }}">
+          <span>{{ taxonomy.name }}</span>
+          <span class="taxonomy-count">{{ taxonomy.size }}</span>
+        </a> 
+      </li>
+    {%- endfor -%}
+  </ul>
+</div>
+
+{%- for taxonomy in taxonomies -%}
+  <h2 id="{{ taxonomy.name }}">{{ taxonomy.name }}</h2>
+  <ul class="post-list-by-taxonomy">
+    {%- assign posts = taxonomy.items -%}
+    {%- for post in posts -%}
+      <li>
+        <time datetime="{{ page.date | date_to_xmlschema }}">{{ post.date | date: "%Y-%m-%d" }}</time> 
+        &raquo;
+        <a href="{{ post.url | relative_url }}">{{ post.title | escape }}</a>
+      </li>
+    {%- endfor -%}
+  </ul>
+  <a href="#" onclick="backToTop()" class="back-to-top">Top &#8648;</a>
+{%- endfor -%}
+
+{% include back-to-top.html %}

data/_includes/back-to-top.html

@@ -0,0 +1,6 @@
+<script>
+  function backToTop() {
+    const main = document.getElementById("site-main");
+    main.scrollTop = 0;
+  }
+</script>

data/_includes/custom-head.html

@@ -0,0 +1,6 @@
+{% comment %}
+  Placeholder to allow defining custom head, in principle, you can add anything here, e.g. favicons:
+
+  1. Head over to https://realfavicongenerator.net/ to add your own favicons.
+  2. Customize default _includes/custom-head.html in your source directory and insert the given code snippet.
+{% endcomment %}

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 }}.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,39 @@
+<footer class="footer">
+  <div class="footer-column">
+    <p>
+      <small>
+        &copy;&nbsp;
+        {%- assign date_from = site.posts[-1].date | date_to_xmlschema -%}
+        {%- assign year_from = date_from | date: '%Y' -%}
+        {%- assign date_to   = site.time | date_to_xmlschema -%}
+        {%- assign year_to   = date_to | date: '%Y' -%}
+        {%- unless year_from == nil or year_from == year_to -%}
+          <time datetime="{{ date_from }}">{{ year_from }}</time>-
+        {%- endunless -%}
+        <time datetime="{{ date_to }}">{{ year_to }}</time>
+        {%- if site.author -%}
+          &nbsp;<a href="{{ site.author.url }}" target="_blank">{{ site.author.name }}</a>
+        {%- endif -%}
+        . All right reserved.
+      </small>
+    </p>
+    <p>
+      <small>
+        Powered by <a href="https://jekyllrb.com/" target="_blank">Jekyll</a> & <a href="https://github.com/szivong/pole" target="_blank">Pole</a>
+      </small>
+    </p>
+  </div>
+  {% if site.data.social %}
+    <div class="footer-column">
+      <ul class="social-icons">
+        {% for social in site.data.social %}
+          <li class="social-icon-item">
+            <a class="social-icon" href="{{ social.url }}" target="_blank">
+              <i class="{{ social.icon | default: 'fas fa-link' }}" title="{{ social.title }}"></i>
+            </a>
+          </li>
+        {% endfor %}
+      </ul>
+    </div>
+  {% endif %}
+</footer>

data/_includes/google-analytics.html

@@ -0,0 +1,9 @@
+<!-- Global site tag (gtag.js) - Google Analytics -->
+<script async src="https://www.googletagmanager.com/gtag/js?id={{ site.google_analytics }}"></script>
+<script>
+  window.dataLayer = window.dataLayer || [];
+  function gtag(){dataLayer.push(arguments);}
+  gtag('js', new Date());
+
+  gtag('config', '{{ site.google_analytics }}');
+</script>

data/_includes/head.html

@@ -0,0 +1,13 @@
+<head>
+  <meta charset="UTF-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <link rel="stylesheet" href="{{ 'assets/normalize.css' | relative_url }}">
+  <link rel="stylesheet" href="{{ 'assets/open-color.css' | relative_url }}">
+  <link rel="stylesheet" href="{{ 'assets/pole/styles.css' | relative_url }}">
+  {% feed_meta %}
+  {% seo %}
+
+  <script async src="https://use.fontawesome.com/releases/v5.0.12/js/all.js"></script>
+  
+  {% include custom-head.html %}
+</head>

data/_includes/header.html

@@ -0,0 +1,20 @@
+<header class="masthead">
+  <div class="masthead-title">
+    <a href="{{ '/' | relative_url }}" title="Home">{{ site.title }}</a>
+    <small class="tagline">{{ site.tagline }}</small>
+  </div>
+
+  {% if site.data.navigation %}
+    <nav class="nav">
+      <ul class="nav-list">
+      {% for item in site.data.navigation %}
+        <li class="nav-item">
+          <a href="{{ item.url | relative_url }}" class="{% if page.url == item.url %}current{% endif %}">
+            {{ item.title }}
+          </a>
+        </li>
+      {% endfor %}
+      </ul>
+    </nav>
+  {% endif %}
+</header>