coppermind 0.2.0 → 3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd5e0c276822c43b514f3ac32efe6937f9c98e121371790bd037ec6f6f2b21e2
-  data.tar.gz: 4f3cfc099d3b641b5cb07eb45229b836c33521671d2325a68dc070ec3dbdbf1b
+  metadata.gz: 27a360c9ee236068ab031e4da03805f93f448d8387faf8125d7732a35373a4bd
+  data.tar.gz: 8a85d6fb840363619fc42647bde7e3e5ff84d67623164124021c101dc57b8139
 SHA512:
-  metadata.gz: 69676a7e065f7cd1cd0804fb347b7eb77914eb5429ce18cc47926ec7c730438fd4a3f323e1f87e5adbb526ae002ba2fea9ee981c81f1609cbd99020e5f2352c4
-  data.tar.gz: 90f7a5c30bc276111b19f0b63ba616e5356d621126a1aac5a36d5d10bf1733bef699095883dbb483855750e3f2186a7572b87bb3efaede51abfe59b1b790d5c4
+  metadata.gz: 59d535d03bdd9d72e24ddec9b15cc9ea1898e52318b280ba7ac1975676b9a895b6b9f5a08eb3ca5c0850df7b7cdbe24d212368778948b7ba6d0dc507cef7b744
+  data.tar.gz: 80a6cb6bbd067e85fb2733515b58d5fc727cc9c6344088fea4366e22dd3a46beb0ac9f87002237ffd74420d8fdd800607a8770d4378fd03ec971aa86573fd94e

data/LICENSE.txt

@@ -1,5 +1,6 @@
 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

data/README.md

@@ -1,59 +1,33 @@
-# Monophase <!-- omit in toc -->
-
-Monophase is *a one-column minimal responsive Jekyll blog theme*.
-
-One of the purposes of Monophase is to be an alternative option to the default theme of Jekyll—[Minima](https://github.com/jekyll/minima). Monophase 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://zivlog.io/monophase/)*.
-
-![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)
-  - [Alignment](#alignment)
-  - [Google Analytics 4](#google-analytics-4)
-  - [Archive](#archive)
-- [Contributing](#contributing)
-- [Development](#development)
-- [License](#license)
-
-## Installation
+# 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 and Initial Setup
+
+### Adding the gem
+
 
 Add this line to your Jekyll site's `Gemfile`:
 
 ```ruby
-gem "monophase"
+gem "coppermind"
 ```
 
 And add this line to your Jekyll site's `_config.yml`:
 
 ```yaml
-theme: monophase
+theme: coppermind
 ```
 
 And then execute:
@@ -65,32 +39,87 @@ bundle
 Or install it yourself as:
 
 ```shell
-gem install monophase
+gem install coppermind
 ```
 
-You can also install the latest code via [`jekyll-remote-theme`](https://github.com/benbalter/jekyll-remote-theme):
+### The navigation bar and homepage
 
-1. Add this line to your Jekyll site's `Gemfile`:
+Before the site is fully functional, you will need to add an index.html file and navigation bar config files.
 
-    ```ruby
-    gem "jekyll-remote-theme"
-    ```
+```html
+<!-- index.html -->
 
-2. Add these lines to your Jekyll site's `_config.yml`:
+---
+layout: home
+---
+```
 
-    ```ruby
-    plugins:
-      - jekyll-remote-theme
+To set up the navigation bar you 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.
 
-    remote_theme: zivhub/monophase@main
-    ```
+```yml
+- title: About
+  url: /about/
+- title: Archive
+  url: /archive/
+- title: Categories
+  url: /categories/
+```
+
+You will also need to add markdown files corresponding to these links in the site's root directory:
 
-## Usage
+```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/
+---
+```
 
-### Global Configuration
+## Customisation
+
+### 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 |
@@ -98,10 +127,34 @@ You can also install the latest code via [`jekyll-remote-theme`](https://github.
 | `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
+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 |
 | -------- | ---- | ------- | ------------- |
@@ -111,85 +164,45 @@ You can also install the latest code via [`jekyll-remote-theme`](https://github.
 | `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
-
-Monophase 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>`.
+A sample post is shown below:
 
-### Navigation
+```md
+<!-- 2021-10-09-welcome-to-jekyll.markdown -->
 
-The navigation bar of Monophase is configurable. You just need to specify titles and URLs in the file `_data/navigation.yml`, for example,
+---
+layout: post
+title:  "Welcome to Jekyll!"
+date:   2021-10-09 11:25:13 +1100
+categories: jekyll update
+tags: jekyll 
+---
 
-```yml
-- title: About
-  url: /about/
-- title: Archive
-  url: /archive/
-- title: Categories
-  url: /categories/
+some text
 ```
 
-### Social Links
+### Homepage
 
-Monophase allows you to show social links on the website. All you need to do is creating a file `_data/social.yml`, for example,
+You can customise the homepage by setting `layout: home` in the frontmatter in an `index.html` file in the base directory.
 
-```yml
-- title: Email
-  url: mailto:zivmsg@gmail.com
-  icon: fas fa-envelope
-- title: Twitter
-  url: https://twitter.com/zivtwt
-  icon: fab fa-twitter
-- title: GitHub
-  url: https://github.com/zivhub
-  icon: fab fa-github
-```
+### 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
 
-Monophase 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.
+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
 
-Monophase also provides some predefined classes to specify the alignment of HTML elements—e.g. images. They are `align-center`, `align-left`, and `align-right`.
-
-### 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
+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`.
 
-Monophase 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/zivhub/monophase](https://github.com/zivhub/monophase). 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.
+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 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 `monophase.gemspec` accordingly.
+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).
+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/_includes/archive-by-tagories.html

@@ -63,7 +63,7 @@
           </li>
         {%- endfor -%}
       </ul>
-      <a href="#" onclick="backToTop()" class="back-to-top">Top &#8648;</a>
+      <a href="#" onclick="backToTop()" class="back-to-top">^</a>
     {%- endif -%}
   {%- endfor -%}
 {%- endfor -%}

data/_includes/archive-by-years.html

@@ -26,7 +26,7 @@
       </li>
     {%- endfor -%}
   </ul>
-  <a href="#" onclick="backToTop()" class="back-to-top">Top &#8648;</a>
+  <a href="#" onclick="backToTop()" class="back-to-top">^</a>
 {%- endfor -%}
 
 {% include back-to-top.html %}

data/_includes/footer.html

@@ -19,7 +19,7 @@
     </p>
     <p>
       <small>
-        Powered by <a href="https://jekyllrb.com/" target="_blank">Jekyll</a> & <a href="https://github.com/zivhub/monophase" target="_blank">Monophase</a>
+        Powered by <a href="https://github.com/JustSoval/Coppermind" target="_blank">Coppermind</a>
       </small>
     </p>
   </div>

data/_sass/monophase/_layout.scss

@@ -33,6 +33,7 @@
   }
 
   .tagline {
+    padding-left: var(--spacer);
     opacity: .5;
   }
 }
@@ -54,12 +55,12 @@
 
     &:hover,
     &:focus {
-      text-decoration: line-through;
+      text-decoration: underline;
     }
   }
 
   a.current {
-    text-decoration: line-through;
+    text-decoration: underline;
   }
 }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: coppermind
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: '3.2'
 platform: ruby
 authors:
-- Jesse WIlliamson
+- Jesse Williamson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-09 00:00:00.000000000 Z
+date: 2021-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: 4.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: 4.2.0
 - !ruby/object:Gem::Dependency
   name: jekyll-feed
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: 0.15.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: 0.15.1
 - !ruby/object:Gem::Dependency
   name: jekyll-paginate
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: 2.7.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: 2.7.1
 - !ruby/object:Gem::Dependency
   name: kramdown-parser-gfm
   requirement: !ruby/object:Gem::Requirement
@@ -89,6 +89,7 @@ extra_rdoc_files: []
 files:
 - LICENSE.txt
 - README.md
+- _config.yml
 - _includes/archive-by-tagories.html
 - _includes/archive-by-years.html
 - _includes/back-to-top.html
@@ -133,7 +134,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.2.21
 signing_key:
 specification_version: 4
 summary: A one-column minimal responsive Jekyll blog theme