coppermind 2.3 → 3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d85311b5f847dd20ebc63db72f8efc2525074715d54ebf76d1d9b1732af17303
-  data.tar.gz: 1f0b0cc4e492500878c5bafff2146ea220719c3ebd2753e78117e63fba0cc546
+  metadata.gz: 683e638992784d15f1ea672a4abf2422cc14527ef1fe84eed3d9c30625555149
+  data.tar.gz: 7c61912367a4ec02f3aec430cdd661f0c9cf124b1344e93e7ad44ea5e983ce42
 SHA512:
-  metadata.gz: 6223994aba02357d888488e8152040b796c5d2e819b5633a66013bcb8410415b965724f6fe9df87ca972b943200e6e3ff1726ea0a2d064e2eb7ea03d38c12545
-  data.tar.gz: da4614c409421179969f7e37a360b1c698e620038aae0100280eaf40882ebe04c846ca558ed266141913e803577101d3a3bf6decf9f66426e7d189dc5a9f2331
+  metadata.gz: 0e0ff2e506cd23276d7fd43ac7133ba8c345b7741d781371b06dd067964e71af570f6bf6248cb09f7211c29ea85607eb0c72d7cd3d35eb7b8365ea7a4e137604
+  data.tar.gz: f5792db063f2a433e516da3adcae07c83210e321e20ff713cabded983c69fa410e19badac2b39842af3c0b2827288385ee8856f9f0c9bf6e5ba25b145daf3722

data/README.md

@@ -1,3 +1,252 @@
-# Coppermind <!-- omit in toc -->
+# Coppermind
 
-Coppermind is a minimal, suckless jekyll theme built upon monophase.
+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 built on the now abandoned [Monophase](https://github.com/whk-io/monophase), but adds several features, updates, and fixes.
+
+## Installation and Initial Setup
+
+### 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
+```
+
+### The navigation bar and homepage
+
+Before the site is fully functional, you will need to add an index.html file and navigation bar config files.
+
+```html
+<!-- index.html -->
+
+---
+layout: home
+---
+```
+
+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.
+
+```yml
+- title: About
+  url: /about/
+
+- title: Years
+  url: /years/
+
+- title: Categories
+  url: /categories/
+
+- title: Tags
+  url: /tags/
+
+```
+
+You will also need to add markdown files corresponding to these links in the site's root directory:
+
+```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/
+---
+```
+
+### The footbar pins
+To include pins in the footer, you need to specify titles, image names, and URLs in the file `_data/pins.yml` as shown in the example below.
+
+```yml
+- title: Larbs
+  url: https://larbs.xyz/
+  image: larbs
+
+- title: XXIIVV
+  url: https://wiki.xxiivv.com/site/home.html
+  image: xxiivv
+
+- title: Luke Smith
+  url: https://lukesmith.xyz/index
+  image: luke
+
+- title: Hundred Rabbits
+  url: https://100r.co/site/home.html
+  image: hundredrabbits
+
+- title: Landchad
+  url: https://landchad.net/
+  image: landchad
+
+- title: Kitchen
+  url: https://grimgrains.com/site/home.html
+  image: kitchen
+```
+
+This configuration corresponds to the following fiiles:
+1. `assets/pins/larbs.gif`
+2. `assets/pins/xxiivv.gif`
+3. `assets/pins/luke.gif`
+4. `assets/pins/hundredrabbits.gif`
+5. `assets/pins/landchad.gif`
+6. `assets/pins/kitchen.gif`
+
+
+## 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 |
+| `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

@@ -1,22 +1,7 @@
-# Welcome to Jekyll!
-#
-# This config file is meant for settings that affect your whole blog, values
-# which you are expected to set up once and rarely edit after that. If you find
-# yourself editing this file very often, consider using Jekyll's data files
-# feature for the data you need to update frequently.
-#
-# For technical reasons, this file is *NOT* reloaded automatically when you use
-# 'bundle exec jekyll serve'. If you change this file, please restart the server process.
-
-# Site settings
-# These are used to personalize your new site. If you look in the HTML files,
-# you will see them accessed via {{ site.title }}, {{ site.email }}, and so on.
-# You can create any custom variable you would like, and they will be accessible
-# in the templates via {{ site.myvariable }}.
 title: Coppermind
-tagline:
+tagline: Your tagline here
 author:
-  name: Jesse Williamson
+  name: Author
 
 # Build settings
 markdown: kramdown
@@ -30,16 +15,3 @@ paginate: 2
 
 tags_path: /tags/
 categories_path: /categories/
-
-
-# Exclude from processing.
-# The following items will not be processed, by default. Create a custom list
-# to override the default setting.
-# exclude:
-#   - Gemfile
-#   - Gemfile.lock
-#   - node_modules
-#   - vendor/bundle/
-#   - vendor/cache/
-#   - vendor/gems/
-#   - vendor/ruby/

data/_includes/footer.html

@@ -1,5 +1,23 @@
+
 <footer class="footer">
-  <div class="footer-column">
+
+  <div class="pinlist">
+    {% if site.data.pins %}
+      {% for item in site.data.pins %}
+        <a href="{{ item.url }}" class="pin">
+          <img src="/assets/pins/{{ item.image }}.gif">
+        </a>
+      {% endfor %}
+    {% endif %}
+  </div>
+  <br>  
+
+  <!-- <p>The quick brown fox jumps over the lazy dog. The quick brown fox jumps over the lazy dog. The quick brown fox jumps over the lazy dog. The quick brown fox jumps over the lazy dog. The quick brown fox jumps over the lazy dog. The quick brown fox jumps over the lazy dog. The quick brown fox jumps over the lazy dog. The quick brown fox jumps over the lazy dog. The quick brown fox jumps over the lazy dog. The quick brown fox jumps over the lazy dog. The quick brown fox jumps over the lazy dog. The quick brown fox jumps over the lazy dog. The quick brown fox jumps over the lazy dog. The quick brown fox jumps over the lazy dog. </p> -->
+
+
+  <div class="attribution">
+
+  <div class="attribution-column">
     <p>
       <small>
         &copy;&nbsp;
@@ -24,7 +42,7 @@
     </p>
   </div>
   {% if site.data.social %}
-    <div class="footer-column">
+    <div class="attribution-column">
       <ul class="social-icons">
         {% for social in site.data.social %}
           <li class="social-icon-item">

data/_sass/monophase/_layout.scss

@@ -269,6 +269,11 @@ a.pagination-item:hover {
   }
 }
 
+.pin{
+  width: 88px;
+  padding-right: var(--spacer);
+}
+
 .social-icons {
   list-style: none;
   padding: 0;
@@ -281,10 +286,21 @@ a.pagination-item:hover {
 }
 
 @media screen and (min-width: $md-screen) {
-  .footer {
+  // .footer{
+  //   padding-left: var(--spacer-2);
+  //   padding-right: var(--spacer-2);
+  // }
+  .attribution {
     display: flex;
   }
-  .footer-column {
+  .pinlist{
+    display:flex;
+    // border:3px solid black;
+    flex-direction:row;
+    flex-wrap:wrap;
+    // justify-content: center;
+  }
+  .attribution-column {
     width: 100%;
   }
   .social-icons {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: coppermind
 version: !ruby/object:Gem::Version
-  version: '2.3'
+  version: '3.3'
 platform: ruby
 authors:
 - 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
@@ -115,6 +115,12 @@ files:
 - assets/monophase/styles.scss
 - assets/normalize.css
 - assets/open-color.css
+- assets/pins/hundredrabbits.gif
+- assets/pins/kitchen.gif
+- assets/pins/landchad.gif
+- assets/pins/larbs.gif
+- assets/pins/luke.gif
+- assets/pins/xxiivv.gif
 homepage: https://github.com/zivhub/monophase
 licenses:
 - MIT
@@ -134,7 +140,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