jekyll-theme-hydure 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '09aea078f2a505f24217466dddee107de01ff95af903f8f3e34a9a7e764dab60'
+  data.tar.gz: eb65132368b6b7b195403b86587ce0679a8e33c3e9814ed04dec76acd7c55de6
+SHA512:
+  metadata.gz: 16598957d05cc43f152bfd38dfe90546325614cba4c0f8b2145f5152ce8c38cc00f83835885429671fcaf49f3a344797b13538233d92c0addca433794e8e3d03
+  data.tar.gz: 8d20f03f502e02781585ebe5816ae9645fdb15bdcf1aacec460887dd0c5cb90942807b5fb6790a9a9e0d1e6549d204eaeebbacf810c3bd0e0acf1bd93d2eec5a

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 zivong
+
+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,184 @@
+# Hydure <!-- omit in toc -->
+
+Hydure is a concise two-column blog theme for Jekyll. It is built on the [Pure.css](https://github.com/pure-css/pure) framework.
+
+Check out the [demo](https://zivong.blog/jekyll-theme-hydure/).
+
+|       | Mobile | Desktop |
+| ----- | ------ | ------- |
+| Light | ![Screenshot mobile light](screenshot-mobile-light.png) | ![Screenshot desktop light](screenshot-desktop-light.png) |
+| Dark  | ![Screenshot mobile dark](screenshot-mobile-dark.png) | ![Screenshot desktop dark](screenshot-desktop-dark.png) |
+
+## Highlight Features <!-- omit in toc -->
+
+- [Open Color](https://github.com/yeun/open-color)
+- Dark mode, via [`prefers-color-scheme`](https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-color-scheme)
+- [Font Awesome](https://fontawesome.com/)
+- [Jekyll Paginate](https://github.com/jekyll/jekyll-paginate)
+- [Jekyll Feed](https://github.com/jekyll/jekyll-feed/)
+- [Jekyll SEO Tag](https://github.com/jekyll/jekyll-seo-tag/)
+- [MathJax](https://www.mathjax.org/)
+- [Disqus](https://disqus.com/)
+- [Google Analytics 4](https://support.google.com/analytics/answer/10089681?hl=en)
+- 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)
+  - [Archive](#archive)
+- [Contributing](#contributing)
+- [Development](#development)
+- [License](#license)
+
+## Installation
+
+Add this line to your Jekyll site's `Gemfile`:
+
+```ruby
+gem "jekyll-theme-hydure"
+```
+
+And add this line to your Jekyll site's `_config.yml`:
+
+```yaml
+theme: jekyll-theme-hydure
+```
+
+And then execute:
+
+```shell
+bundle
+```
+
+Or install it yourself as:
+
+```shell
+gem install jekyll-theme-hydure
+```
+
+If your website is hosted on GitHub Pages, you can install this theme via [`jekyll-remote-theme`](https://github.com/benbalter/jekyll-remote-theme).
+
+Add the following to your `Gemfile`:
+
+```ruby
+gem "jekyll-remote-theme"
+```
+
+And add this line to your Jekyll site's `_config.yml`:
+
+```yml
+plugins:
+  - jekyll-remote-theme
+```
+
+Add the following to your site's `_config.yml`:
+
+```yml
+remote_theme: zivong/jekyll-theme-hydure
+```
+
+## Usage
+
+### Global Configuration
+
+| Variable | Type | Default | Specification |
+| -------- | ---- | ------- | ------------- |
+| `lang` | String | `en` | The language of pages; The value can be overwritten by the `lang` variable on each page. |
+| `title` | String | --- | The title of the website |
+| `tagline` | String | --- | The tagline of the website |
+| `cover` | String | --- | The URL of the sidebar cover image; The value can be overwritten by the `cover` variable on each page. |
+| `author.name` | String | --- | The name of the website author |
+| `author.url` | String | --- | A URL of the website author |
+| `disqus` | String | --- | Disqus short name |
+| `google_analytics` | String | --- | Google Analytics 4 Measurement ID |
+| `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 |
+
+### 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 |
+| `math` | Boolean | `false` | Does enable MathJax on this page |
+| `comments` | Boolean | `true` | Does enable the Disqus comment system |
+
+### Homepage
+
+You can create a homepage for your site by setting `layout: home` in your `index.html`.
+
+### Custom Head
+
+Hydure 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 menu of Hydure is configurable. You just need to specify titles and URLs in the file `_data/navigation.yml`, for example,
+
+```yml
+- title: Home
+  url: /
+- title: About
+  url: /about/
+- title: Archive
+  url: /archive/
+```
+
+### Social Links
+
+Hydure allows you to show social links on your website. All you need to do is creating a file `_data/social.yml`, for example,
+
+```yml
+- title: Email
+  url: mailto:zivong@protonmail.com
+  icon: fas fa-envelope
+- title: Twitter
+  url: https://twitter.com/zivong91
+  icon: fab fa-twitter
+- title: GitHub
+  url: https://github.com/zivong
+  icon: fab fa-github
+```
+
+### Alert Messages
+
+Hydure provides a predefined class `message` to specify **alert messages**. You may add it to single elements like a `<p>`, or to a parent if there are multiple elements to show.
+
+### Archive
+
+Hydure 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/zivong/jekyll-theme-hydure. 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 `jekyll-theme-hydure.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,68 @@
+{%- 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>
+    {%- endif -%}
+  {%- endfor -%}
+{%- endfor -%}

data/_includes/archive-by-years.html

@@ -0,0 +1,29 @@
+{% 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>
+{%- endfor -%}

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,25 @@
+<footer class="footer pure-g">
+  <div class="pure-u-1 pure-u-md-1-2">
+    <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>
+  </div>
+
+  <div class="pure-u-1 pure-u-md-1-2">
+    <small>
+      Powered by <a href="https://jekyllrb.com/" target="_blank">Jekyll</a> & <a href="https://github.com/zivong/jekyll-theme-hydure" target="_blank">Hydure</a>
+    </small>
+  </div>
+</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,15 @@
+<head>
+  <meta charset="utf-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  {% feed_meta %}
+  {% seo %}
+  
+  <link rel="stylesheet" href="https://unpkg.com/purecss@2.0.5/build/pure-min.css" crossorigin="anonymous">
+  <link rel="stylesheet" href="https://unpkg.com/purecss@2.0.5/build/grids-responsive-min.css">
+  <link rel="stylesheet" href="{{ 'assets/css/open-color.css' | relative_url }}">
+  <link rel="stylesheet" href="{{ 'assets/css/hydure.css' | relative_url }}">
+
+  <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,32 @@
+<header class="header">
+  <a class="brand-title" href="{{ '/' | relative_url }}">{{ site.title }}</a>
+  <p class="brand-tagline">{{ site.tagline }}</p>
+
+  {% if site.data.navigation %}
+    <nav class="nav pure-menu">
+      <ul class="pure-menu-list">
+      {% for item in site.data.navigation %}
+        <li class="nav-item pure-menu-item">
+          <a href="{{ item.url | relative_url }}" class="pure-menu-link {% if page.url == item.url %}current{% endif %}">
+            {{ item.title }}
+          </a>
+        </li>
+      {% endfor %}
+      </ul>
+    </nav>
+  {% endif %}
+
+  {% if site.data.social %}
+    <div class="social pure-menu pure-menu-horizontal">
+      <ul class="social-list pure-menu-list">
+        {% for social in site.data.social %}
+          <li class="social-item pure-menu-item">
+            <a class="pure-menu-link pure-button" href="{{ social.url }}" target="_blank">
+              <i class="{{ social.icon | default: 'fas fa-link' }}" title="{{ social.title }}"></i>
+            </a>
+          </li>
+        {% endfor %}
+      </ul>
+    </div>
+  {% endif %}
+</header>

data/_includes/mathjax.html

@@ -0,0 +1,2 @@
+<script src="https://polyfill.io/v3/polyfill.min.js?features=es6"></script>
+<script id="MathJax-script" async src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>

data/_layouts/archive.html

@@ -0,0 +1,15 @@
+---
+layout: default
+---
+
+<article>
+  <h1>{{ page.title }}</h1>
+
+  {{ content }}
+
+  {% if page.type == "years" %}
+    {% include archive-by-years.html %}
+  {% else %}
+    {% include archive-by-tagories.html %}
+  {% endif %}
+</article>