coppermind 2.3 → 3.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +199 -2
- data/_config.yml +2 -30
- data/_data/navigation.yml +8 -0
- data/about.md +27 -0
- data/categories.md +6 -0
- data/index.html +3 -0
- data/tags.md +6 -0
- data/years.md +6 -0
- metadata +8 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 85eb2af8f523b74584e69b1df4c2145a3141ac9e92a0f81e9230a8c8715b2290
|
|
4
|
+
data.tar.gz: 066c694e4aee859a795ea92834519b16fb3373a317abe026411f5bbe361f18b9
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 38eaee830e87288dd807a40612c482c3f1ff62219d067f0d422a8cdf74d2709cfd437511336a29a2024c6480b075332b7b521c8eb3727688061f12f3a05d6f86
|
|
7
|
+
data.tar.gz: 696dcb95855958c304e82a00553030cb0e688d9fac6f5d6592d528c5e3226aeb0d77aa81c02bd62251f5841ec544628e4ce85e3f5dcce1d219db648b4f08d08d
|
data/README.md
CHANGED
|
@@ -1,3 +1,200 @@
|
|
|
1
|
-
# Coppermind
|
|
1
|
+
# Coppermind
|
|
2
2
|
|
|
3
|
-
Coppermind is a minimal
|
|
3
|
+
Coppermind is *a one-column minimal responsive Jekyll blog theme*.
|
|
4
|
+
|
|
5
|
+
## Why another Jekyll theme?
|
|
6
|
+
|
|
7
|
+
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.
|
|
8
|
+
|
|
9
|
+
## About
|
|
10
|
+
|
|
11
|
+
This project:
|
|
12
|
+
|
|
13
|
+
- Is built as a theme for [Jekyll](https://jekyllrb.com)
|
|
14
|
+
- Was created as a fork of [Monophase](https://github.com/whk-io/monophase) with additional features, fixes, and customisations
|
|
15
|
+
|
|
16
|
+
## Installation
|
|
17
|
+
|
|
18
|
+
### Adding the gem
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
Add this line to your Jekyll site's `Gemfile`:
|
|
22
|
+
|
|
23
|
+
```ruby
|
|
24
|
+
gem "coppermind"
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
And add this line to your Jekyll site's `_config.yml`:
|
|
28
|
+
|
|
29
|
+
```yaml
|
|
30
|
+
theme: coppermind
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
And then execute:
|
|
34
|
+
|
|
35
|
+
```shell
|
|
36
|
+
bundle
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
Or install it yourself as:
|
|
40
|
+
|
|
41
|
+
```shell
|
|
42
|
+
gem install coppermind
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
## Customisation
|
|
46
|
+
|
|
47
|
+
### Customising the navigation bar
|
|
48
|
+
|
|
49
|
+
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.
|
|
50
|
+
|
|
51
|
+
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.
|
|
52
|
+
|
|
53
|
+
```yml
|
|
54
|
+
- title: About
|
|
55
|
+
url: /about/
|
|
56
|
+
- title: Archive
|
|
57
|
+
url: /archive/
|
|
58
|
+
- title: Categories
|
|
59
|
+
url: /categories/
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
These links correspond to markdown files in the baseurl:
|
|
63
|
+
|
|
64
|
+
```md
|
|
65
|
+
<!-- about.md -->
|
|
66
|
+
|
|
67
|
+
---
|
|
68
|
+
layout: page
|
|
69
|
+
title: About
|
|
70
|
+
permalink: /about/
|
|
71
|
+
---
|
|
72
|
+
|
|
73
|
+
some text
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
```md
|
|
77
|
+
<!-- categories.md -->
|
|
78
|
+
|
|
79
|
+
---
|
|
80
|
+
layout: archive
|
|
81
|
+
type: categories
|
|
82
|
+
title: Categories
|
|
83
|
+
permalink: /categories/
|
|
84
|
+
---
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
```md
|
|
88
|
+
<!-- tags.md -->
|
|
89
|
+
|
|
90
|
+
---
|
|
91
|
+
layout: archive
|
|
92
|
+
type: tags
|
|
93
|
+
title: Tags
|
|
94
|
+
permalink: /tags/
|
|
95
|
+
---
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
```md
|
|
99
|
+
<!-- years.md -->
|
|
100
|
+
|
|
101
|
+
---
|
|
102
|
+
layout: archive
|
|
103
|
+
type: years
|
|
104
|
+
title: Years
|
|
105
|
+
permalink: /years/
|
|
106
|
+
---
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
### Config.yml options
|
|
110
|
+
In addition to the standard Jekyll config.yml settings, Coppermind supports the following:
|
|
111
|
+
|
|
112
|
+
| Variable | Type | Default | Specification |
|
|
113
|
+
| -------- | ---- | ------- | ------------- |
|
|
114
|
+
| `paginate` | int | --- | The number of posts to include on the homepage |
|
|
115
|
+
| `title` | String | --- | The title of the website |
|
|
116
|
+
| `tagline` | String | --- | The tagline of the website |
|
|
117
|
+
| `lang` | String | `en` | The language of pages; The value can be overwritten by the `lang` variable on each page |
|
|
118
|
+
| `author.name` | String | --- | The name of the website author |
|
|
119
|
+
| `author.url` | String | --- | A URL of the website author |
|
|
120
|
+
| `tags_path` | String | --- | A path to the archive-by-tags page; It is used by tags on each post |
|
|
121
|
+
| `categories_path` | String | --- | A path to the archive-by-categories page; It is used by categories on each post |
|
|
122
|
+
|
|
123
|
+
The default config is shown below:
|
|
124
|
+
|
|
125
|
+
```md
|
|
126
|
+
<!-- config.yml -->
|
|
127
|
+
|
|
128
|
+
title: Coppermind
|
|
129
|
+
tagline: Your tagline here
|
|
130
|
+
author:
|
|
131
|
+
name: Author
|
|
132
|
+
|
|
133
|
+
# Build settings
|
|
134
|
+
markdown: kramdown
|
|
135
|
+
plugins:
|
|
136
|
+
- jekyll-feed
|
|
137
|
+
- jekyll-paginate
|
|
138
|
+
- jekyll-seo-tag
|
|
139
|
+
- kramdown-parser-gfm
|
|
140
|
+
|
|
141
|
+
paginate: 2
|
|
142
|
+
|
|
143
|
+
tags_path: /tags/
|
|
144
|
+
categories_path: /categories/
|
|
145
|
+
```
|
|
146
|
+
|
|
147
|
+
### Page frontmatter
|
|
148
|
+
|
|
149
|
+
In addition to the standard Jekyll frontmatter configuration, Coppermind supports the following:
|
|
150
|
+
|
|
151
|
+
| Variable | Type | Default | Specification |
|
|
152
|
+
| -------- | ---- | ------- | ------------- |
|
|
153
|
+
| `description` | String | --- | A description of the current post |
|
|
154
|
+
| `last_modified_at` | String | --- | The date of the last modification you made on a post after its publishing |
|
|
155
|
+
| `author` | String or Array | --- | The author name(s) of the post |
|
|
156
|
+
| `comments` | Boolean | `true` | Does enable the Disqus comment system |
|
|
157
|
+
| `math` | Boolean | `false` | Does enable MathJax on this page |
|
|
158
|
+
|
|
159
|
+
A sample post is shown below:
|
|
160
|
+
|
|
161
|
+
```md
|
|
162
|
+
<!-- 2021-10-09-welcome-to-jekyll.markdown -->
|
|
163
|
+
|
|
164
|
+
---
|
|
165
|
+
layout: post
|
|
166
|
+
title: "Welcome to Jekyll!"
|
|
167
|
+
date: 2021-10-09 11:25:13 +1100
|
|
168
|
+
categories: jekyll update
|
|
169
|
+
tags: jekyll
|
|
170
|
+
---
|
|
171
|
+
|
|
172
|
+
some text
|
|
173
|
+
```
|
|
174
|
+
|
|
175
|
+
### Homepage
|
|
176
|
+
|
|
177
|
+
You can customise the homepage by setting `layout: home` in the frontmatter in an `index.html` file in the base directory.
|
|
178
|
+
|
|
179
|
+
### Custom Head
|
|
180
|
+
|
|
181
|
+
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>`.
|
|
182
|
+
|
|
183
|
+
### Alert Messages
|
|
184
|
+
|
|
185
|
+
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.
|
|
186
|
+
|
|
187
|
+
### Alignment
|
|
188
|
+
|
|
189
|
+
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`.
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
## Development
|
|
193
|
+
|
|
194
|
+
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`.
|
|
195
|
+
|
|
196
|
+
When a new gem version is released, only the files in specified in the gemspec regexp and tracked with Git will be bundled.
|
|
197
|
+
|
|
198
|
+
## License
|
|
199
|
+
|
|
200
|
+
The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
|
data/_config.yml
CHANGED
|
@@ -1,22 +1,7 @@
|
|
|
1
|
-
# Welcome to Jekyll!
|
|
2
|
-
#
|
|
3
|
-
# This config file is meant for settings that affect your whole blog, values
|
|
4
|
-
# which you are expected to set up once and rarely edit after that. If you find
|
|
5
|
-
# yourself editing this file very often, consider using Jekyll's data files
|
|
6
|
-
# feature for the data you need to update frequently.
|
|
7
|
-
#
|
|
8
|
-
# For technical reasons, this file is *NOT* reloaded automatically when you use
|
|
9
|
-
# 'bundle exec jekyll serve'. If you change this file, please restart the server process.
|
|
10
|
-
|
|
11
|
-
# Site settings
|
|
12
|
-
# These are used to personalize your new site. If you look in the HTML files,
|
|
13
|
-
# you will see them accessed via {{ site.title }}, {{ site.email }}, and so on.
|
|
14
|
-
# You can create any custom variable you would like, and they will be accessible
|
|
15
|
-
# in the templates via {{ site.myvariable }}.
|
|
16
1
|
title: Coppermind
|
|
17
|
-
tagline:
|
|
2
|
+
tagline: Your tagline here
|
|
18
3
|
author:
|
|
19
|
-
name:
|
|
4
|
+
name: Author
|
|
20
5
|
|
|
21
6
|
# Build settings
|
|
22
7
|
markdown: kramdown
|
|
@@ -30,16 +15,3 @@ paginate: 2
|
|
|
30
15
|
|
|
31
16
|
tags_path: /tags/
|
|
32
17
|
categories_path: /categories/
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
# Exclude from processing.
|
|
36
|
-
# The following items will not be processed, by default. Create a custom list
|
|
37
|
-
# to override the default setting.
|
|
38
|
-
# exclude:
|
|
39
|
-
# - Gemfile
|
|
40
|
-
# - Gemfile.lock
|
|
41
|
-
# - node_modules
|
|
42
|
-
# - vendor/bundle/
|
|
43
|
-
# - vendor/cache/
|
|
44
|
-
# - vendor/gems/
|
|
45
|
-
# - vendor/ruby/
|
data/about.md
ADDED
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
---
|
|
2
|
+
layout: page
|
|
3
|
+
title: About
|
|
4
|
+
permalink: /about/
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
This repository contains many sample files (including this one) for testing. They are not included in the final theme gem, so feel free to modify, add, or remove them as necessary.
|
|
8
|
+
{: .message-info }
|
|
9
|
+
|
|
10
|
+
Coppermind is *a one-column minimal responsive Jekyll blog theme*.
|
|
11
|
+
|
|
12
|
+
Learn more and contribute on [GitHub](https://github.com/JustSoval/Coppermind).
|
|
13
|
+
|
|
14
|
+
## Why another Jekyll theme?
|
|
15
|
+
|
|
16
|
+
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.
|
|
17
|
+
|
|
18
|
+
## Setup
|
|
19
|
+
|
|
20
|
+
This project:
|
|
21
|
+
|
|
22
|
+
- Is built as a theme for [Jekyll](https://jekyllrb.com)
|
|
23
|
+
- Was created as a fork of [Monophase](https://github.com/whk-io/monophase) with additional features, fixes, and customisations
|
|
24
|
+
|
|
25
|
+
Have questions or suggestions? Feel free to [open an issue on GitHub](https://github.com/zivhub/Coppermind/issues/new).
|
|
26
|
+
|
|
27
|
+
Thanks for reading!
|
data/categories.md
ADDED
data/index.html
ADDED
data/tags.md
ADDED
data/years.md
ADDED
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: coppermind
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: '
|
|
4
|
+
version: '3.0'
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Jesse Williamson
|
|
@@ -90,6 +90,7 @@ files:
|
|
|
90
90
|
- LICENSE.txt
|
|
91
91
|
- README.md
|
|
92
92
|
- _config.yml
|
|
93
|
+
- _data/navigation.yml
|
|
93
94
|
- _includes/archive-by-tagories.html
|
|
94
95
|
- _includes/archive-by-years.html
|
|
95
96
|
- _includes/back-to-top.html
|
|
@@ -112,9 +113,14 @@ files:
|
|
|
112
113
|
- _sass/monophase/_predefined.scss
|
|
113
114
|
- _sass/monophase/_variables.scss
|
|
114
115
|
- _sass/monophase/main.scss
|
|
116
|
+
- about.md
|
|
115
117
|
- assets/monophase/styles.scss
|
|
116
118
|
- assets/normalize.css
|
|
117
119
|
- assets/open-color.css
|
|
120
|
+
- categories.md
|
|
121
|
+
- index.html
|
|
122
|
+
- tags.md
|
|
123
|
+
- years.md
|
|
118
124
|
homepage: https://github.com/zivhub/monophase
|
|
119
125
|
licenses:
|
|
120
126
|
- MIT
|
|
@@ -134,7 +140,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
134
140
|
- !ruby/object:Gem::Version
|
|
135
141
|
version: '0'
|
|
136
142
|
requirements: []
|
|
137
|
-
rubygems_version: 3.
|
|
143
|
+
rubygems_version: 3.2.21
|
|
138
144
|
signing_key:
|
|
139
145
|
specification_version: 4
|
|
140
146
|
summary: A one-column minimal responsive Jekyll blog theme
|