jekyll-theme-poole 2.0.1 → 2.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (4) hide show
  1. checksums.yaml +4 -4
  2. data/LICENSE.md +2 -2
  3. data/README.md +71 -0
  4. metadata +57 -1
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 16296e954062a1e51f2234801835fca540c30efb7828be8839e1c22f76d7d4b5
4
- data.tar.gz: fdcc7eb63497c2a1d548dad27b7b9a321d16a026e68988865a4f4365950606b4
3
+ metadata.gz: 286070e94b64b59990ec7617235bc9ad9409606d5f5bef7effc0ae90401f3091
4
+ data.tar.gz: e3299c2b9ead244f16686738e364f774a2dddc48badb6d1608976e1c8fede007
5
5
  SHA512:
6
- metadata.gz: 07e770cc07d4bb9102ce9064e609671a548f25bdf5f55aa471c2f6b338848a9c7c743b3d3ae35253a333633faefa327e079021d91592ff64f3f240731c083cae
7
- data.tar.gz: 2aaf9f52689305625ae0e93993105445f09baccf03bb43b54851c141666abda42d9f8246ac6de048b2c2492bbf4a02947c57699bb399c743fb4747b98cd5ebd7
6
+ metadata.gz: 8e8726e95fa10839819899f9fd7b54d6b822c67db846182ecb34adec3cc6ff2cf0cc8fc88bdb559cfd90ef1aae0413face3ed6bc289afbe4ee5a411e5cb3fe3e
7
+ data.tar.gz: '03769b4817f437cd424602864bf049f446910bbbba9c0cffee383497ef5cd274df9e2b9bd5914fad6661aea57f26820d1564bd41b186f233024290268480ded1'
data/LICENSE.md CHANGED
@@ -1,9 +1,9 @@
1
1
  # Released under MIT License
2
2
 
3
- Copyright (c) 2013 Mark Otto.
3
+ Copyright (c) 2013-present Mark Otto and contributors
4
4
 
5
5
  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
6
6
 
7
7
  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
8
8
 
9
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
9
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
data/README.md CHANGED
@@ -97,6 +97,77 @@ html {
97
97
 
98
98
  To easily scale your site's typography and components, simply customize the base `font-size`s here.
99
99
 
100
+ ## Install as a gem-based theme
101
+
102
+ Jekyll encourage the use of `bundler` to manage themes and plugins. [Themes](https://jekyllrb.com/docs/themes/) can be packaged as Ruby gems since Jekyll 3.3. If you don't intend to modify the theme a lot, this is a nice way of focusing on your content and benefits from theme updates.
103
+
104
+ ### 1. Install theme
105
+
106
+ 1. Create a folder that will be your Jekyll source directory, e.g `blog`.
107
+ 2. Create a `Gemfile` in your source directory to list all theme dependencies, it should looks like this:
108
+
109
+ ```ruby
110
+ # frozen_string_literal: true
111
+
112
+ source "https://rubygems.org"
113
+
114
+ gem "jekyll", "~> 3.7.0"
115
+ gem "jekyll-theme-poole", "~> 2.0"
116
+ ```
117
+
118
+ ### 2. Configuration
119
+
120
+ 1. Run `bundle install` to install all theme dependencies.
121
+ 2. Copy [`_config.yml`](example/_config.yml), [`index.html`](example/index.html), [`404.html`](example/404.html) (and [`about.md`](example/about.md)) from this repository's [example files](example) to your source directory.
122
+ 3. Run `bundle exec jekyll serve --livereload` to preview your website locally.
123
+
124
+ If you list the files in your source directory, don't be surprised if you only see:
125
+
126
+ ```
127
+ ├── 404.html # default 404 page template
128
+ ├── Gemfile # bundler configuration
129
+ ├── Gemfile.lock # bundler version lock
130
+ ├── _config.yml # jekyll configuration
131
+ ├── _posts # your posts are here
132
+ ├── _site # default destination build directory
133
+ ├── about.md # default example page
134
+ └── index.html # list all the posts on the homepage
135
+ ```
136
+
137
+ :bulb: When you use gem-based themes, the themes files don't appear in your source directory, they're packaged within the gem.
138
+
139
+ If you wonder where the original theme files are, `bundler` allows you to show a gem content:
140
+
141
+ ```sh
142
+ tree $(bundle show jekyll-theme-poole)
143
+ ├── LICENSE.md
144
+ ├── README.md
145
+ ├── _includes
146
+ │   └── head.html
147
+ ├── _layouts
148
+ │   ├── default.html
149
+ │   ├── home.html
150
+ │   ├── page.html
151
+ │   └── post.html
152
+ ├── _sass
153
+ │   ├── _base.scss
154
+ │   ├── _code.scss
155
+ │   ├── _layout.scss
156
+ │   ├── _masthead.scss
157
+ │   ├── _message.scss
158
+ │   ├── _pagination.scss
159
+ │   ├── _posts.scss
160
+ │   ├── _syntax.scss
161
+ │   ├── _type.scss
162
+ │   └── _variables.scss
163
+ └── assets
164
+ ├── apple-touch-icon-precomposed.png
165
+ ├── favicon.ico
166
+ └── styles.scss
167
+ ```
168
+
169
+ If you want to customize the theme, you'll have to copy the files you need to modify in your source directory.
170
+ Report to jekyll's documentation to learn [how to override a theme](https://jekyllrb.com/docs/themes/#overriding-theme-defaults).
100
171
 
101
172
  ## Development
102
173
 
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: jekyll-theme-poole
3
3
  version: !ruby/object:Gem::Version
4
- version: 2.0.1
4
+ version: 2.1.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Mark Otto
@@ -24,6 +24,62 @@ dependencies:
24
24
  - - "~>"
25
25
  - !ruby/object:Gem::Version
26
26
  version: '3.6'
27
+ - !ruby/object:Gem::Dependency
28
+ name: jekyll-feed
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '0.9'
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '0.9'
41
+ - !ruby/object:Gem::Dependency
42
+ name: jekyll-gist
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '1.5'
48
+ type: :runtime
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '1.5'
55
+ - !ruby/object:Gem::Dependency
56
+ name: jekyll-paginate
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '1.1'
62
+ type: :runtime
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '1.1'
69
+ - !ruby/object:Gem::Dependency
70
+ name: jekyll-sitemap
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - "~>"
74
+ - !ruby/object:Gem::Version
75
+ version: '1.1'
76
+ type: :runtime
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - "~>"
81
+ - !ruby/object:Gem::Version
82
+ version: '1.1'
27
83
  - !ruby/object:Gem::Dependency
28
84
  name: bundler
29
85
  requirement: !ruby/object:Gem::Requirement