coppermind 0.1.4 → 3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 27024e8c2df6b244ca07e9eddcc3c055ece8b01d2424a9f6367c61860e83f4f2
-  data.tar.gz: bdf862486394a11532c367ac3b36f986f7fd80661fafc467b464454210fef0c2
+  metadata.gz: 85eb2af8f523b74584e69b1df4c2145a3141ac9e92a0f81e9230a8c8715b2290
+  data.tar.gz: 066c694e4aee859a795ea92834519b16fb3373a317abe026411f5bbe361f18b9
 SHA512:
-  metadata.gz: 362ffe533cd091ca99e5d850deed9018d05d7713ab2fd635531e568967f593fe6b8ee16f37fdf9c8754e93d2603a973143626b9324914cc7333b8c807091415d
-  data.tar.gz: f877027f76e240df797e14312ee28aefa6770bede78ee4832e9825c8532233779f1c313ba56e07e120b64040ae6717e00da3b99afc9f2bbfec7b749d02db5246
+  metadata.gz: 38eaee830e87288dd807a40612c482c3f1ff62219d067f0d422a8cdf74d2709cfd437511336a29a2024c6480b075332b7b521c8eb3727688061f12f3a05d6f86
+  data.tar.gz: 696dcb95855958c304e82a00553030cb0e688d9fac6f5d6592d528c5e3226aeb0d77aa81c02bd62251f5841ec544628e4ce85e3f5dcce1d219db648b4f08d08d

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Jesse Williamson
+Copyright (c) 2021 Song-Zi Vong
+
+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,200 @@
+# Coppermind
+
+Coppermind is *a one-column minimal responsive Jekyll blog theme*.
+
+## Why another Jekyll theme?
+
+The modern web is bloated and disorganised. Pages load slowly and require large, resource-hungry web browsers to acess them. The machines and networks of years ago would be entirely adequate today if the programs they run were better optimised. This project seeks to provide a simple, low-dependency framework for creation of static sites.
+
+## About
+
+This project:
+
+- Is built as a theme for [Jekyll](https://jekyllrb.com)
+- Was created as a fork of [Monophase](https://github.com/whk-io/monophase) with additional features, fixes, and customisations
+
+## Installation
+
+### Adding the gem
+
+
+Add this line to your Jekyll site's `Gemfile`:
+
+```ruby
+gem "coppermind"
+```
+
+And add this line to your Jekyll site's `_config.yml`:
+
+```yaml
+theme: coppermind
+```
+
+And then execute:
+
+```shell
+bundle
+```
+
+Or install it yourself as:
+
+```shell
+gem install coppermind
+```
+
+## Customisation
+
+### Customising the navigation bar
+
+By default Coppermind includes a navigation bar with three archive pages. This is not intended to be the final configuration for all users, and is highly configurable.
+
+To customise the navigation bar you just need to specify titles and URLs in the file `_data/navigation.yml`. For example, the following will give you a navbar with an *about* page and three archive pages.
+
+```yml
+- title: About
+  url: /about/
+- title: Archive
+  url: /archive/
+- title: Categories
+  url: /categories/
+```
+
+These links correspond to markdown files in the baseurl:
+
+```md
+<!-- about.md -->
+
+---
+layout: page
+title: About
+permalink: /about/
+---
+
+some text
+```
+
+```md
+<!-- categories.md -->
+
+---
+layout: archive
+type: categories
+title: Categories
+permalink: /categories/
+---
+```
+
+```md
+<!-- tags.md -->
+
+---
+layout: archive
+type: tags
+title: Tags
+permalink: /tags/
+---
+```
+
+```md
+<!-- years.md -->
+
+---
+layout: archive
+type: years
+title: Years
+permalink: /years/
+---
+```
+
+### Config.yml options
+In addition to the standard Jekyll config.yml settings, Coppermind supports the following:
+
+| Variable | Type | Default | Specification |
+| -------- | ---- | ------- | ------------- |
+| `paginate` | int | --- | The number of posts to include on the homepage |
+| `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 |
+
+The default config is shown below:
+
+```md
+<!-- config.yml -->
+
+title: Coppermind
+tagline: Your tagline here
+author:
+  name: Author
+
+# Build settings
+markdown: kramdown
+plugins:
+  - jekyll-feed
+  - jekyll-paginate
+  - jekyll-seo-tag
+  - kramdown-parser-gfm
+  
+paginate: 2
+
+tags_path: /tags/
+categories_path: /categories/
+```
+
+### Page frontmatter
+
+In addition to the standard Jekyll frontmatter configuration, Coppermind supports the following:
+
+| 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 |
+
+A sample post is shown below:
+
+```md
+<!-- 2021-10-09-welcome-to-jekyll.markdown -->
+
+---
+layout: post
+title:  "Welcome to Jekyll!"
+date:   2021-10-09 11:25:13 +1100
+categories: jekyll update
+tags: jekyll 
+---
+
+some text
+```
+
+### Homepage
+
+You can customise the homepage by setting `layout: home` in the frontmatter in an `index.html` file in the base directory.
+
+### Custom Head
+
+Coppermind leaves a placeholder to allow inserting custom HTML into the page head. HTML code in `_includes/custom-head.html` will be automatically included in `<head>`.
+
+### Alert Messages
+
+Coppermind 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.
+
+### Alignment
+
+Coppermind also provides some predefined classes to specify the alignment of HTML elements—e.g. images. They are `align-center`, `align-left`, and `align-right`.
+
+
+## Development
+
+To set up your environment to develop this theme, run `bundle install`. This theme is setup just like a normal Jekyll site with various filler files for testing. To test the theme, run `bundle exec jekyll serve` and open your browser at `http://localhost:4000`.
+
+When a new gem version is released, only the files in specified in the gemspec regexp and tracked with Git will be bundled.
+
+## License
+
+The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/_config.yml

@@ -0,0 +1,17 @@
+title: Coppermind
+tagline: Your tagline here
+author:
+  name: Author
+
+# Build settings
+markdown: kramdown
+plugins:
+  - jekyll-feed
+  - jekyll-paginate
+  - jekyll-seo-tag
+  - kramdown-parser-gfm
+  
+paginate: 2
+
+tags_path: /tags/
+categories_path: /categories/

data/_data/navigation.yml

@@ -0,0 +1,8 @@
+# - title: About
+#   url: /about/
+- title: Years
+  url: /years/
+- title: Categories
+  url: /categories/
+- title: Tags
+  url: /tags/

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">^</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">^</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://github.com/JustSoval/Coppermind" target="_blank">Coppermind</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/monophase/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>

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,23 @@
+<!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>

data/_layouts/home.html

@@ -0,0 +1,44 @@
+---
+layout: default
+---
+
+<div class="posts">
+  {% assign posts = site.posts %}
+  {% if paginator %}
+    {% assign posts = paginator.posts %}
+  {% endif %}
+  {% for post in posts %}
+    <div class="post">
+      <h2 class="post-title">
+        <a href="{{ post.url | relative_url }}">
+          {{ post.title }}
+        </a>
+      </h2>
+
+      <time datetime="{{ post.date | date_to_xmlschema }}" class="post-meta">{{ post.date | date_to_string }}</time>
+
+      <p class="post-excerpt">
+        {% if post.description %}
+          {{ post.description | strip_html }}
+        {% else %}
+          {{ post.excerpt | strip_html }}
+        {% endif %}
+      </p>
+    </div>
+  {% endfor %}
+</div>
+
+{% if paginator %}
+  <div class="pagination">
+    {% if paginator.next_page %}
+      <a class="pagination-item older" href="{{ paginator.next_page_path | relative_url }}">Older</a>
+    {% else %}
+      <span class="pagination-item older">Older</span>
+    {% endif %}
+    {% if paginator.previous_page %}
+      <a class="pagination-item newer" href="{{ paginator.previous_page_path | relative_url }}">Newer</a>
+    {% else %}
+      <span class="pagination-item newer">Newer</span>
+    {% endif %}
+  </div>
+{% endif %}

data/_layouts/page.html

@@ -0,0 +1,8 @@
+---
+layout: default
+---
+
+<article class="page">
+  <h1 class="page-title">{{ page.title }}</h1>
+  {{ content }}
+</article>

data/_layouts/post.html

@@ -0,0 +1,86 @@
+---
+layout: default
+---
+
+<article class="post">
+  <h1 class="post-title">{{ page.title }}</h1>
+  <div class="post-meta">
+    <time datetime="{{ page.date | date_to_xmlschema }}" itemprop="datePublished">
+      {{ page.date | date_to_string }}
+    </time>
+    {%- if page.last_modified_at -%}
+      <span> ~ </span>
+      {%- assign mdate = page.last_modified_at | date_to_xmlschema -%}
+      <time datetime="{{ mdate }}" itemprop="dateModified">
+        {{ mdate | date_to_string }}
+      </time>
+    {%- endif -%}
+    {%- if page.author -%}
+      <span> • </span>
+      {% for author in page.author %}
+        <span itemprop="author" itemscope itemtype="http://schema.org/Person">
+          {{ author }}
+        </span>
+        {%- if forloop.last == false %}, {% endif -%}
+      {% endfor %}
+    {%- endif -%}
+    {% if page.categories.size > 0 %}
+      <span> • </span>
+      <span class="post-categories-section">
+        <i class="post-categories-icon fas fa-folder"></i>
+        <ul class="post-categories">
+          {%- for category in page.categories -%}
+            <li>
+              {% assign slugified_category = category | slugify %}
+              {%- if site.categories_path -%}
+                <a class="post-category" href="{{ site.categories_path | relative_url }}#{{ slugified_category }}">{{ category }}</a>
+              {%- else -%}
+                <span class="post-category">{{ category }}</span>
+              {%- endif -%}
+            </li>
+          {%- endfor -%}
+        </ul>
+      </span>
+    {% endif %}
+    {% if page.tags.size > 0 %}
+      <span> • </span>
+      <span class="post-tags-section">
+        <i class="post-tags-icon fas fa-tag"></i>
+        <ul class="post-tags">
+          {%- for tag in page.tags -%}
+            <li>
+              {% assign slugified_tag = tag | slugify %}
+              {%- if site.tags_path -%}
+                <a class="post-tag" href="{{ site.tags_path | relative_url }}#{{ slugified_tag }}">{{ slugified_tag }}</a>
+              {%- else -%}
+                <span class="post-tag">{{ slugified_tag }}</span>
+              {%- endif -%}
+            </li>
+          {%- endfor -%}
+        </ul>
+      </span>
+    {% endif %}
+  </div>
+
+  {{ content }}
+
+  {% if jekyll.environment == "production" and site.disqus and page.comments != false %}
+    {% include disqus.html %}
+  {% endif %}
+</article>
+
+{% if site.related_posts != empty %}
+  <aside class="related">
+    <h2 class="related-title">Related posts</h2>
+    <ul class="related-posts">
+      {% for post in site.related_posts limit:3 %}
+        <li>
+          <a href="{{ post.url | relative_url }}">
+            {{ post.title }}
+          </a>
+          <small><time datetime="{{ post.date | date_to_xmlschema }}">{{ post.date | date_to_string }}</time></small>
+        </li>
+      {% endfor %}
+    </ul>
+  </aside>
+{% endif %}