coppermind 3.0 → 3.1

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 85eb2af8f523b74584e69b1df4c2145a3141ac9e92a0f81e9230a8c8715b2290
4
- data.tar.gz: 066c694e4aee859a795ea92834519b16fb3373a317abe026411f5bbe361f18b9
3
+ metadata.gz: 393ec09024ed0c443ec7b0167ec9694f68c43dc74de6f448f492070598541bef
4
+ data.tar.gz: 34280e1f8cd8508b67e52bfb017c1e092bd6b5bfe8d34f8ed6cf0b88b8d5f173
5
5
  SHA512:
6
- metadata.gz: 38eaee830e87288dd807a40612c482c3f1ff62219d067f0d422a8cdf74d2709cfd437511336a29a2024c6480b075332b7b521c8eb3727688061f12f3a05d6f86
7
- data.tar.gz: 696dcb95855958c304e82a00553030cb0e688d9fac6f5d6592d528c5e3226aeb0d77aa81c02bd62251f5841ec544628e4ce85e3f5dcce1d219db648b4f08d08d
6
+ metadata.gz: 6316cf97bf0e3a16c28a869d5008dde10572a7db281357ba5305247766fbe20f9ba94362a58c5a9654c57149c477ce30f33cc9c965e298f72f73f5a5aa2f74ed
7
+ data.tar.gz: adf2651d86f50ba27fd2a08e3c9769891fea9562386f5933024ec1c3ec2deed5ecf919aeb68c75c98713457b591c32cf327752c7a8d500262e1e3b62f82910c7
data/README.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  Coppermind is *a one-column minimal responsive Jekyll blog theme*.
4
4
 
5
- ## Why another Jekyll theme?
5
+ ## Why Another Jekyll Theme?
6
6
 
7
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
8
 
@@ -13,7 +13,7 @@ This project:
13
13
  - Is built as a theme for [Jekyll](https://jekyllrb.com)
14
14
  - Was created as a fork of [Monophase](https://github.com/whk-io/monophase) with additional features, fixes, and customisations
15
15
 
16
- ## Installation
16
+ ## Installation and Initial Setup
17
17
 
18
18
  ### Adding the gem
19
19
 
@@ -42,13 +42,19 @@ Or install it yourself as:
42
42
  gem install coppermind
43
43
  ```
44
44
 
45
- ## Customisation
45
+ ### The navigation bar and homepage
46
46
 
47
- ### Customising the navigation bar
47
+ Before the site is fully functional, you will need to add an index.html file and navigation bar config files.
48
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.
49
+ ```html
50
+ <!-- index.html -->
50
51
 
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
+ layout: home
54
+ ---
55
+ ```
56
+
57
+ 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.
52
58
 
53
59
  ```yml
54
60
  - title: About
@@ -59,7 +65,7 @@ To customise the navigation bar you just need to specify titles and URLs in the
59
65
  url: /categories/
60
66
  ```
61
67
 
62
- These links correspond to markdown files in the baseurl:
68
+ You will also need to add markdown files corresponding to these links in the site's root directory:
63
69
 
64
70
  ```md
65
71
  <!-- about.md -->
@@ -106,6 +112,8 @@ permalink: /years/
106
112
  ---
107
113
  ```
108
114
 
115
+ ## Customisation
116
+
109
117
  ### Config.yml options
110
118
  In addition to the standard Jekyll config.yml settings, Coppermind supports the following:
111
119
 
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: '3.0'
4
+ version: '3.1'
5
5
  platform: ruby
6
6
  authors:
7
7
  - Jesse Williamson
@@ -90,7 +90,6 @@ files:
90
90
  - LICENSE.txt
91
91
  - README.md
92
92
  - _config.yml
93
- - _data/navigation.yml
94
93
  - _includes/archive-by-tagories.html
95
94
  - _includes/archive-by-years.html
96
95
  - _includes/back-to-top.html
@@ -113,14 +112,9 @@ files:
113
112
  - _sass/monophase/_predefined.scss
114
113
  - _sass/monophase/_variables.scss
115
114
  - _sass/monophase/main.scss
116
- - about.md
117
115
  - assets/monophase/styles.scss
118
116
  - assets/normalize.css
119
117
  - assets/open-color.css
120
- - categories.md
121
- - index.html
122
- - tags.md
123
- - years.md
124
118
  homepage: https://github.com/zivhub/monophase
125
119
  licenses:
126
120
  - MIT
data/_data/navigation.yml DELETED
@@ -1,8 +0,0 @@
1
- # - title: About
2
- # url: /about/
3
- - title: Years
4
- url: /years/
5
- - title: Categories
6
- url: /categories/
7
- - title: Tags
8
- url: /tags/
data/about.md DELETED
@@ -1,27 +0,0 @@
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 DELETED
@@ -1,6 +0,0 @@
1
- ---
2
- layout: archive
3
- type: categories
4
- title: Categories
5
- permalink: /categories/
6
- ---
data/index.html DELETED
@@ -1,3 +0,0 @@
1
- ---
2
- layout: home
3
- ---
data/tags.md DELETED
@@ -1,6 +0,0 @@
1
- ---
2
- layout: archive
3
- type: tags
4
- title: Tags
5
- permalink: /tags/
6
- ---
data/years.md DELETED
@@ -1,6 +0,0 @@
1
- ---
2
- layout: archive
3
- type: years
4
- title: Years
5
- permalink: /years/
6
- ---