jekyll-theme-bas-style-kit 0.2.1 → 0.2.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (7) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +11 -0
  3. data/README.md +57 -22
  4. data/_config.yml +38 -0
  5. data/_data/bsk_jekyll_vars.json +1 -1
  6. data/screenshot.png +0 -0
  7. metadata +17 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: bd393bc036c961724e631611903a5c48782fe4e6
4
- data.tar.gz: cf5895144a6f24ecd68d48d609962478b712de96
3
+ metadata.gz: 27e058d72d3084eb2185c1df62d36d07f1b22197
4
+ data.tar.gz: 01c5f19ad9bb5ba81f7d9c1af6c4f0740711c930
5
5
  SHA512:
6
- metadata.gz: 401a1f8721aad2bfe03bd633b2d403846afa2df07174b01cc67aa0dc0bdec3cac22c703f95c07d16783a3b7a11086aa4feeb5da86fadd7abbe4cae6e839acbd9
7
- data.tar.gz: 31c0140946971f1d1519e2a3d072536efb63662c7ceb6ecaf487945cb1ac174c5f198f7c48a8630f4becef11111232d99722f8aa8876f65ed29f5c05942cf1a2
6
+ metadata.gz: ca06ea89900753879f17f966be66d01019b2477e4221e8ae28e651c7e3bf6f3b346ff466af35b3104f7058057fcc871e8b81f33bb7ef2aa14ba1772bf98fc491
7
+ data.tar.gz: dc774fa7b8f205b0d8eea90892ec45fbd01a69c6fbd80af311b7eb7cb3c870b7ef3b67444e7805ee2258a62e163cf40e7d24c9fcfcfe48686b60b2ad16043915
data/CHANGELOG.md CHANGED
@@ -5,6 +5,17 @@ This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html
5
5
 
6
6
  ## [Unreleased][unreleased]
7
7
 
8
+ ### Added
9
+
10
+ * Jekyll Data plugin as a theme/gem dependency, allows default config options to be set, and the use of theme data files
11
+
12
+ ### Changed
13
+
14
+ * Including theme config file in Gemspec to allow default config options to be set
15
+ * Switching previous config file used for previewing the theme to an internal config file
16
+ * Config option documentation is now consistent, and includes whether a default value is set for each option
17
+ * Updating theme screen shot
18
+
8
19
  ## 0.2.1 - 21/03/2017
9
20
 
10
21
  ### Added
data/README.md CHANGED
@@ -30,10 +30,22 @@ Refer to [Jekyll's theme documentation](https://jekyllrb.com/docs/themes/) for g
30
30
 
31
31
  ### Selecting the BAS Style Kit Jekyll theme
32
32
 
33
- Add this line to your Jekyll site's `_config.yml`:
33
+ Add these lines to your Jekyll site's `_config.yml`:
34
34
 
35
35
  ```yaml
36
36
  theme: jekyll-theme-bas-style-kit
37
+
38
+ gems:
39
+ - jekyll-data
40
+ ```
41
+
42
+ **Note:** This theme sets additional config options, see the *Config options* section for more information.
43
+
44
+ **Note:** If you have loaded any Jekyll plugins using the `gems` option, also include these plugins:
45
+
46
+ ```yaml
47
+ gems:
48
+ - jekyll-data
37
49
  ```
38
50
 
39
51
  ### Layouts
@@ -262,25 +274,32 @@ be left empty if not needed.
262
274
 
263
275
  ### Config options
264
276
 
265
- There are a number of config options used by this theme, which **SHOULD** be set, within `_config.yml`.
266
-
267
- Jekyll config options which **SHOULD** be set:
277
+ There are a number of general config options which **SHOULD** be set for this theme:
268
278
 
269
- * `title`
270
- * `description`
279
+ | Option | Type | Description | Default Value | Example Value | Notes |
280
+ | ------------- | ------ | -------------------------- | ------------- | --------------------------------------------------- | ------------------------------------------ |
281
+ | `title` | String | Name of the website | *None* | "Example Website" | Also used for the title HTML property |
282
+ | `description` | String | Description of the website | *None* | "Example website for the BAS Style Kit Jekyll Theme | Used in the description meta HTTP property |
271
283
 
272
- Theme specific options which **SHOULD** be set:
284
+ There are a number of theme specific config options, some of which **SHOULD** be set:
273
285
 
274
- | Option | Type | Description | Example Value | Notes |
275
- | ------------------- | ------ | -------------------------------------------------------------- | --------------------- | --------------------------------------------------------------------------- |
276
- | `phase` | String | Current development phase for website | "alpha" | See the *Development phase notice* section for more information |
277
- | `copyright_href` | String | URL to copyright statement for website | "/copyright-statement | See the *Legal policies* section for more information |
278
- | `privacy_href` | String | URL to privacy policy for website | "/privacy-policy" | See the *Legal policies* section for more information |
279
- | `cookies_href` | String | URL to cookie policy for website | "/cookie-policy" | See the *Legal policies* section for more information |
280
- | `feedback_href` | String | URL to feedback page for website | "/feedback" | See the *Website feedback* section for more information |
281
- | `ga_property` | String | Google Analytics property for website | "UA-64130716-XX" | Values should start with `UA-64130716-` for BAS Google Analytics properties |
282
- | `nav_items` | List | Items in this website to include in the site navigation | *List of items* | See the *Site navigation* section for more information |
283
- | `nav_related_sites` | List | Items for other BAS websites to include in the site navigation | *List of items* | See the *Site navigation* section for more information |
286
+ | Option | Type | Description | Default Value | Example Value | Notes |
287
+ | ------------------- | ------ | -------------------------------------------------------------- | ------------- | ---------------------- | --------------------------------------------------------------------------- |
288
+ | `phase` | String | Current development phase of the website | `live` | `alpha` | See the *Development phase notice* section for more information |
289
+ | `copyright_href` | String | URL to copyright statement of the website | *None* | `/copyright-statement` | See the *Legal policies* section for more information |
290
+ | `privacy_href` | String | URL to privacy policy of the website | *None* | `/privacy-policy` | See the *Legal policies* section for more information |
291
+ | `cookies_href` | String | URL to cookie policy of the website | *None* | `/cookie-policy` | See the *Legal policies* section for more information |
292
+ | `feedback_href` | String | URL to feedback page of the website | *None* | `/feedbac` | See the *Website feedback* section for more information |
293
+ | `ga_property` | String | Google Analytics property of the website | *None* | `UA-64130716-XX` | Values should start with `UA-64130716-` for BAS Google Analytics properties |
294
+ | `nav_items` | List | Items in the website to include in the site navigation | *None* | *List of items* | See the *Site navigation* section for more information |
295
+ | `nav_related_sites` | List | Items for other BAS websites to include in the site navigation | *List* | *List of items* | See the *Site navigation* section for more information |
296
+
297
+ There are some additional general config options which are set by this theme, but can be overriden if needed:
298
+
299
+ | Option | Type | Description | Default Value | Example Value | Notes |
300
+ | ----------- | ------ | -------------------------------------------------------------------- | ------------- | --------------- | ------------------------------------------------------------------------ |
301
+ | `gems` | List | List of Jekyll plugins to include, set to dependencies of this theme | *List* | *List of items* | If this option is set within a website, ensure these values are included |
302
+ | `permalink` | String | Removes the `.html` file extension from URLs generated by Jekyll | `pretty` | `pretty` | Other options are available, see the Jekyll documentation |
284
303
 
285
304
  ### Theme variables
286
305
 
@@ -689,6 +708,20 @@ $ docker-compose push app
689
708
  [1] The first time you use this registry, you will need to authenticate using:
690
709
  `docker login docker-registry.data.bas.ac.uk`
691
710
 
711
+ ### Jekyll plugins
712
+
713
+ Additional Jekyll plugins can be used by listing them as dependencies of this theme.
714
+
715
+ When the theme is installed by an end-user these plugins will be also be installed. This theme includes a `_config.yml`
716
+ to set `gems` option to include any required plugins.
717
+
718
+ ### Jekyll config options
719
+
720
+ The Jekyll Data plugin is used to set config options within sites that use this theme. For this to work the site still
721
+ needs to call the Data plugin, other config options can then be set by this plugin.
722
+
723
+ **Note:** Make sure to document which config options are set by this theme, especially conventional options.
724
+
692
725
  ### Ruby Gem
693
726
 
694
727
  This theme is distributed as a Ruby Gem, through the public [Ruby Gems](https://rubygems.org) gem hosting service.
@@ -703,11 +736,13 @@ listed it won't be included. This is separate to the Git `.gitignore` file.
703
736
  1. bump version in `jekyll-theme-bas-style-kit.gemspec` and `docker-compose.yml` and `_data/bsk_jekyll_vars.json`
704
737
  2. `docker-compose build`
705
738
  3. `docker-compose push`
706
- 4. update screen-shot (width: 900px)
707
- 5. close release
708
- 6. commit changes to git and tag with new version
709
- 7. `docker-compose run app gem build jekyll-theme-bas-style-kit.gemspec`
710
- 8. `docker-compose run app gem push jekyll-theme-bas-style-kit-*.gem`
739
+ 4. if new plugins have been added, update the usage section for where users override the `gems` config option
740
+ 5. if new config options have been set, update the usage section
741
+ 6. update screen-shot (width: 900px)
742
+ 7. close release
743
+ 8. commit changes to git and tag with new version
744
+ 9. `docker-compose run app gem build jekyll-theme-bas-style-kit.gemspec`
745
+ 10. `docker-compose run app gem push jekyll-theme-bas-style-kit-*.gem`
711
746
 
712
747
  ## Issue tracking
713
748
 
data/_config.yml ADDED
@@ -0,0 +1,38 @@
1
+ # This file is **NOT** a standard Jekyll config file.
2
+ #
3
+ # It is used to define config options for use by the BAS Style Kit Jekyll Theme, which will be merged together with
4
+ # individual website options at runtime using the Jekyll Data plugin.
5
+
6
+ # If any of these options are set within a site's config file, it will override the values defined here.
7
+
8
+ # Plugins (required by this theme)
9
+
10
+ gems:
11
+ - jekyll-data
12
+
13
+ # Set default permalink format
14
+
15
+ permalink: pretty
16
+
17
+ # Set default development phase
18
+
19
+ phase: live
20
+
21
+ # Set default layout
22
+
23
+ defaults:
24
+ -
25
+ scope:
26
+ path: "" # an empty string here means all files in the project
27
+ values:
28
+ layout: "default"
29
+
30
+ # Set default related sites
31
+
32
+ nav_related_sites:
33
+ -
34
+ name: BAS Home
35
+ href: https://www.bas.ac.uk
36
+ -
37
+ name: Discover BAS data
38
+ href: https://data.bas.ac.uk
data/_data/bsk_jekyll_vars.json CHANGED
@@ -1,4 +1,4 @@
1
1
  {
2
- "theme_version": "0.2.1",
2
+ "theme_version": "0.2.2",
3
3
  "bsk_version": "0.1.0"
4
4
  }
data/screenshot.png CHANGED
Binary file
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: jekyll-theme-bas-style-kit
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
  - Felix Fennell
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2017-03-20 00:00:00.000000000 Z
11
+ date: 2017-03-21 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: jekyll
@@ -24,6 +24,20 @@ dependencies:
24
24
  - - "~>"
25
25
  - !ruby/object:Gem::Version
26
26
  version: '3.4'
27
+ - !ruby/object:Gem::Dependency
28
+ name: jekyll-data
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '1.0'
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '1.0'
27
41
  - !ruby/object:Gem::Dependency
28
42
  name: bundler
29
43
  requirement: !ruby/object:Gem::Requirement
@@ -64,6 +78,7 @@ files:
64
78
  - LICENSE-MIT.md
65
79
  - LICENSE.md
66
80
  - README.md
81
+ - _config.yml
67
82
  - _data/bsk_jekyll_js.json
68
83
  - _data/bsk_jekyll_vars.json
69
84
  - _includes/layout/cookie-banner.html