jekyll-theme-scaffold 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d89c1e753e4771a39e629f85cf09c306f68b0448811e8e0e7a04380e4d1c5a29
+  data.tar.gz: f2640e65ffa96312f5857fe64dbb30651958d63aa0c1a9e13a2609d0e357adfb
+SHA512:
+  metadata.gz: 4736ece470225d567b1a3235301b1cce0ab2ef79fdcf8146bd42bf64c1faa2d22c94ad5f64d9292b62603b6b99b64eae216cdd6798c7f513db7e1b926350395a
+  data.tar.gz: 2ff2ee1d464c110ca40eb2d1b61728e65058d9dcad2e9039fd164e58df1340ef7814d93d1a6660e5880035d65524d683b55499367026f61a903f91fe10c3a4ad

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 sziv2p
+
+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,176 @@
+# Scaffold <!-- omit in toc -->
+
+Scaffold is a *one-column minimalist Jekyll theme for bloggers*.
+
+According to [Merriam-Webster](https://www.merriam-webster.com/), a *scaffold* is
+
+> a temporary or movable platform for workers (such as bricklayers, painters, or miners) to stand or sit on when working at a height above the floor or ground
+
+So is the target of the Jekyll theme Scaffold. It doesn't need to be modern, powerful, colorful, or beautiful; It just needs to be **simple**, **proper**, **naked**, and **neat**.
+
+Scaffold is empirical. Standing on it, you -- the blogger -- can build a great building based on your words.
+
+*Check the [live demo](https://sziv2p.github.io/jekyll-theme-scaffold/).*
+
+![Screenshot](screenshot.png)
+
+## Features (Not a Complete List) <!-- omit in toc -->
+
+- [Normalize.css](http://necolas.github.io/normalize.css/)
+- [Open Color](https://yeun.github.io/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/)
+- Archive implemented by pure Liquid
+- Pagination, via [`jekyll-paginate`](https://rubygems.org/gems/jekyll-paginate)
+- [Jekyll Feed](https://github.com/jekyll/jekyll-feed/)
+- [Jekyll SEO Tag](https://github.com/jekyll/jekyll-seo-tag/)
+- [Jekyll Sitemap](https://github.com/jekyll/jekyll-sitemap/)
+- [Google Analytics](https://analytics.google.com/)
+- [Disqus](https://disqus.com/)
+- [MathJax](https://www.mathjax.org/)
+
+## Table of Contents <!-- omit in toc -->
+
+- [Installation](#installation)
+- [Usage](#usage)
+  - [Global Configuration](#global-configuration)
+  - [Post Configuration](#post-configuration)
+  - [Homepage](#homepage)
+  - [Navigation](#navigation)
+  - [Social Links](#social-links)
+  - [Archive](#archive)
+  - [Custom Head](#custom-head)
+- [Contributing](#contributing)
+- [Development](#development)
+- [License](#license)
+
+## Installation
+
+Add this line to your Jekyll site's `Gemfile`:
+
+```ruby
+gem "jekyll-theme-scaffold"
+```
+
+And add this line to your Jekyll site's `_config.yml`:
+
+```yaml
+theme: jekyll-theme-scaffold
+```
+
+And then execute:
+
+    bundle
+
+Or install it yourself as:
+
+    gem install jekyll-theme-scaffold
+
+If you want to use this theme on GitHub Pages, you can do that via `jekyll-remote-theme`:
+
+1. Import `jekyll-remote-theme` in your `Gemfile`:
+
+    ```ruby
+    gem "jekyll-remote-theme"
+    ```
+
+2. Add these lines to your `_config.yml`:
+
+    ```yml
+    plugins:
+      - jekyll-remote-theme
+
+    remote_theme: sziv2p/jekyll-theme-scaffold
+    ```
+
+## 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 |
+| `date_format` | String | `%-d %b %Y` | The [date format](http://alanwsmith.com/jekyll-liquid-date-formatting-examples) which is used in many places on the website |
+| `tags_path` | String | --- | A path to the archive-by-tags page; It is used by tags on each post |
+| `google_analytics` | String | --- | Google Analytics tracking ID |
+| `disqus` | String | --- | Disqus short name |
+
+### Post Configuration
+
+| Variable | Type | Default | Specification |
+| -------- | ---- | ------- | ------------- |
+| `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 blog by setting `layout: home` in your `index.html`.
+
+### Navigation
+
+You can configure the navigation of the website by creating a file `_data/navigation.yml` in your repository, and put some data such as below into it.
+
+```yml
+- title: About
+  url: /about/
+- title: Archive
+  url: /archive/
+```
+
+### Social Links
+
+Scaffold 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:sziv2p@gmail.com
+  icon: fas fa-envelope
+- title: Twitter
+  url: https://twitter.com/sziv2p
+  icon: fab fa-twitter
+- title: GitHub
+  url: https://github.com/sziv2p
+  icon: fab fa-github
+```
+
+The `icon` property means a [Font Awesome](https://fontawesome.com/) class, and you can select any one you like.
+
+### Archive
+
+Pure 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`.
+
+### Custom Head
+
+Pure 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>`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [https://github.com/sziv2p/jekyll-theme-scaffold](https://github.com/sziv2p/jekyll-theme-scaffold). 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-scaffold.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,33 @@
+<footer class="footer">
+  <div class="footer-column">
+    <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 -%}
+    </small>
+    <br>
+    <small>Powered by <a href="https://jekyllrb.com/" target="_blank">Jekyll</a> & <a href="https://github.com/sziv2p/jekyll-theme-pure" target="_blank">Pure</a></small>
+  </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 @@
+<script async src="https://www.googletagmanager.com/gtag/js?id={{ site.google_analytics }}"></script>
+<script>
+  window['ga-disable-{{ site.google_analytics }}'] = window.doNotTrack === "1" || navigator.doNotTrack === "1" || navigator.doNotTrack === "yes" || navigator.msDoNotTrack === "1";
+  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,12 @@
+<head>
+  <meta charset="UTF-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <link rel="stylesheet" href="{{ 'assets/css/scaffold/normalize.css' | relative_url }}">
+  <link rel="stylesheet" href="{{ 'assets/css/scaffold/open-color.css' | relative_url }}">
+  <link rel="stylesheet" href="{{ 'assets/css/scaffold/styles.css' | relative_url }}">
+  <script async src="https://use.fontawesome.com/releases/v5.0.12/js/all.js"></script>
+  {% feed_meta %}
+  {% seo %}
+
+  {% include custom-head.html %}
+</head>

data/_includes/header.html

@@ -0,0 +1,15 @@
+<header class="masthead">
+  <a class="masthead-title" href="{{ '/' | relative_url }}" title="Home">{{ site.title }}</a>
+  <small class="masthead-tagline">{{ site.tagline }}</small>
+  {% 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 }}">{{ item.title }}</a>
+        </li>
+      {%- endfor -%}
+      </ul>
+    </nav>
+  {% 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>

data/_layouts/default.html

@@ -0,0 +1,21 @@
+<!doctype html>
+<html lang="{{ page.lang | default: site.lang | default: "en" }}">
+  {% include head.html %}
+  <body>
+    <div class="container">
+      {% include header.html %}
+      <main>
+        {{ content }}
+      </main>
+      {% include footer.html %}
+    </div>
+
+    {% if page.math %}
+      {% include mathjax.html %}
+    {% endif %}
+    
+    {% if jekyll.environment == 'production' and site.google_analytics %}
+      {% include google-analytics.html %}
+    {% endif %}
+  </body>
+</html>