classic-jekyll-theme 0.2.1 → 0.2.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +54 -1
  3. metadata +1 -2
  4. data/_config.yml +0 -55
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: e1ae224e9a2e49f3b6babdddc6881029a4f2e708
4
- data.tar.gz: 5a800502d9043d33dd3a1f926a2a9f07ce2cdee4
3
+ metadata.gz: eda925390912ce90b3291af33070e9f9e855b425
4
+ data.tar.gz: 113b6ad96c50ec33a5ca84dc30988aa760a7ad6c
5
5
  SHA512:
6
- metadata.gz: 677fe54cc8706e7dce0ce0c40a5359d8edaa75e4fb74d60f9d25e4a98ec5a80d3319db7190e698d4e0e81277afd81a8bfd7fe807419dd3235f4b0d42d03bb0d8
7
- data.tar.gz: 2db73bd3389afc905711238c13e8f0c4828081fa65b32df68f68f94bd015308e9067063cd5696500c4b3c565ce2d397368e298744b91e1d94fe95ea24517eb59
6
+ metadata.gz: b37ffbf2ec0de81bce0243356f96e3de81e5885ff4ebf1fa0688ffb516528db984fc6c72c9c8e3fdae07d930dbf64d1b1c1c87eb28d8b058051ea54cf244e877
7
+ data.tar.gz: d31bdb50dbe3646b575679f3f1cfacc3afcb097cce6d72efde5b02c28838de27f4260e74439caaee110438666bbe723a257710fbf40b000ff1a57e4e9a35a535
data/README.md CHANGED
@@ -30,13 +30,66 @@ Category pages are created semi-automatically; the web designer has to identify
30
30
 
31
31
  For european users a cookies policy is included by default. It can be easily disabled for non-european websites though.
32
32
 
33
- ## Installation
33
+ ## Installation & setup
34
34
 
35
35
  Install it as:
36
36
 
37
37
  $ sudo gem install classic-jekyll-theme
38
38
 
39
+ Create a new project:
39
40
 
41
+ $ jekyll new great-site
42
+
43
+ Change the directory:
44
+
45
+ $ cd great-site
46
+
47
+ Change in the Gemfile:
48
+
49
+ From `gem "minima", "~> 2.0"` to `gem "classic-jekyll-theme"`
50
+
51
+ Change in the _config.yml:
52
+
53
+ From `theme: minima` to `theme: classic-jekyll-theme`
54
+
55
+ Delete the file `about.md`:
56
+
57
+ $ rm about.md
58
+
59
+ If the jekyll server is started:
60
+
61
+ $ jekyll serve
62
+
63
+ Then the site will show up at `localhost:4000` but it will not contain everything just yet.
64
+
65
+ Next add the settings for __secondary_column__, __tertiary_column__, __number-of-posts-on-home-page__, __number-of-recent-posts-in-widget__ and __enable-cookies-policy__ to the `_config.yml` file with the values you would like to use. Alternatively simply copy and paste the following few lines to the `_config.yml` file:
66
+
67
+ # Classic Jekyll Theme settings
68
+
69
+ # Classic uses three columns Primary, Secondary and Tertiary.
70
+ # The primary column is always present and cannot be manipulated.
71
+ # The secondary column is optional and is either to the left or to the right of the primary.
72
+ # The tertiary column is optional and if present will be opposite the secondary column in the wide display and below the secondary in the medium display.
73
+ # In the narrow display all three columns will be below each other (if present)
74
+ # If the tertiary column is used, the secondary column *must* also be used.
75
+
76
+ secondary_column: left # must be either 'left', 'right' or 'none', other values are illegal.
77
+ tertiary_column: present # must be either 'present' or 'none', other values are illegal.
78
+
79
+ number-of-posts-on-home-page: 5
80
+ number-of-recent-posts-in-widget: 10
81
+
82
+ enable-cookies-policy: yes # yes to include, no to disable
83
+
84
+ # End Classic Jekyll Theme settings
85
+
86
+ If the jekyll server was started, then it must be stopped now (CTRL-C) and restarted:
87
+
88
+ $ jekyll serve
89
+
90
+ Reload the website, and the columns will show up.
91
+
92
+ To add sample content that illustrates how pages and categories are implemented, copy the folder `pages` from the gem to the current project. On MacOS the gems are located in: `Library/Ruby/Gems/<version>/gems/classic-jekyll-theme-<version>`. Replace the <version>'s with the appropriate numbers (note: these are two different unrelated version numbers). These pages not only contain examples, but also some additional information about using the theme.
40
93
 
41
94
  ## Usage
42
95
 
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: classic-jekyll-theme
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.2.1
4
+ version: 0.2.2
5
5
  platform: ruby
6
6
  authors:
7
7
  - Rien
@@ -81,7 +81,6 @@ extra_rdoc_files: []
81
81
  files:
82
82
  - LICENSE.txt
83
83
  - README.md
84
- - _config.yml
85
84
  - _includes/disqus_comments.html
86
85
  - _includes/footer.html
87
86
  - _includes/google-analytics.html
data/_config.yml DELETED
@@ -1,55 +0,0 @@
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 these 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
- title: Your awesome title
17
- email: your-email@domain.com
18
- description: > # this means to ignore newlines until "baseurl:"
19
- Write an awesome description for your new site here. You can edit this
20
- line in _config.yml. It will appear in your document head meta (for
21
- Google search results) and in your feed.xml site description.
22
- baseurl: "" # the subpath of your site, e.g. /blog
23
- url: "" # the base hostname & protocol for your site, e.g. http://example.com
24
- twitter_username: jekyllrb
25
- github_username: jekyll
26
-
27
-
28
- # Classic Jekyll Theme settings
29
-
30
- # Classic uses three columns Primary, Secondary and Tertiary.
31
- # The primary column is always present and cannot be manipulated.
32
- # The secondary column is optional and is either to the left or to the right of the primary.
33
- # The tertiary column is optional and if present will be opposite the secondary column in the wide display and below the secondary in the medium display.
34
- # In the narrow display all three columns will be below each other (if present)
35
- # If the tertiary column is used, the secondary column *must* also be used.
36
-
37
- secondary_column: left # must be either 'left', 'right' or 'none', other values are illegal.
38
- tertiary_column: present # must be either 'present' or 'none', other values are illegal.
39
-
40
- number-of-posts-on-home-page: 5
41
- number-of-recent-posts-in-widget: 10
42
-
43
- enable-cookies-policy: yes # yes to include, no to disable
44
-
45
- # End Classic Jekyll Theme settings
46
-
47
-
48
- # Build settings
49
- markdown: kramdown
50
- theme: classic-jekyll-theme
51
- gems:
52
- - jekyll-feed
53
- exclude:
54
- - Gemfile
55
- - Gemfile.lock