jekyll-theme-bas-style-kit 0.8.0 → 0.9.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +16 -0
- data/README.md +325 -97
- data/_data/bas-style-kit/bsk-css.yml +2 -2
- data/_data/bas-style-kit/bsk-js.yml +4 -4
- data/_data/bas-style-kit/bsk-vars.yml +2 -2
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: f065e17e8b2747bf095b9856f103a51014fbfd34dd135beecac6e954b940920e
|
|
4
|
+
data.tar.gz: 1a855495621e64329de7f966cf032488c11993f68529772623d4ad5d41309be4
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 0e343338277106b1b48af5601725ebc03aaa1e1a07850fbad562c054241386a7a1b77af829a8a3e72f35615f6cd0123aa553aa6846940140ad2b8569c32a406e
|
|
7
|
+
data.tar.gz: b31d0fc487db006bda7ca0019d483b00bbac0be3754d0091b2e77ad00bf0d3b24c97f9d2fad7de19f97fcc4912e8508c5bb1975be6dd43dec01edc4330c81134
|
data/CHANGELOG.md
CHANGED
|
@@ -5,6 +5,22 @@ This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html
|
|
|
5
5
|
|
|
6
6
|
## [Unreleased][unreleased]
|
|
7
7
|
|
|
8
|
+
## 0.9.0 - 2019-07-02
|
|
9
|
+
|
|
10
|
+
### Added
|
|
11
|
+
|
|
12
|
+
* Updated to Style Kit 0.6.0-alpha
|
|
13
|
+
|
|
14
|
+
### Fixed
|
|
15
|
+
|
|
16
|
+
* Updating Gem lock file to fix gem versioning issue
|
|
17
|
+
* Correcting use of deprecated `js-libs` in the BAS CDN
|
|
18
|
+
|
|
19
|
+
### Changed
|
|
20
|
+
|
|
21
|
+
* Major refactoring and simplification of README and other documentation
|
|
22
|
+
* Removing versioning from Docker containers
|
|
23
|
+
|
|
8
24
|
## 0.8.0 - 2018-11-28
|
|
9
25
|
|
|
10
26
|
### Added
|
data/README.md
CHANGED
|
@@ -34,18 +34,101 @@ theme: jekyll-theme-bas-style-kit
|
|
|
34
34
|
|
|
35
35
|
Refer to [Jekyll's theme documentation](https://jekyllrb.com/docs/themes/) for general information.
|
|
36
36
|
|
|
37
|
+
### Quick start
|
|
37
38
|
|
|
39
|
+
Add these lines to your `_config.yml` file:
|
|
38
40
|
|
|
41
|
+
```yml
|
|
42
|
+
bas_style_kit_jekyll_theme:
|
|
43
|
+
attributes:
|
|
44
|
+
head_title:
|
|
45
|
+
default: 'Example service'
|
|
46
|
+
appended: ' - Example service'
|
|
47
|
+
head_description: 'Service to act as an example'
|
|
48
|
+
site_brand:
|
|
49
|
+
text: 'Example service'
|
|
50
|
+
href: '/'
|
|
51
|
+
site_development_phase: 'beta'
|
|
52
|
+
site_feedback_href: '/feedback'
|
|
53
|
+
legal_policies:
|
|
54
|
+
cookies_href: '/legal/cookies'
|
|
55
|
+
copyright_href: '/legal/copyright'
|
|
56
|
+
privacy_href: '/legal/privacy'
|
|
57
|
+
# Optional - add a custom CSS file with a relative URL
|
|
58
|
+
site_styles:
|
|
59
|
+
-
|
|
60
|
+
href: '/css/main.css'
|
|
61
|
+
type: 'local'
|
|
62
|
+
# Optional - add a custom JS file with a SRI value
|
|
63
|
+
site_scripts:
|
|
64
|
+
-
|
|
65
|
+
href: 'https://example.com/js/example.js'
|
|
66
|
+
integrity: 'abc123'
|
|
67
|
+
type: 'remote'
|
|
68
|
+
# Optional - enable web analytics
|
|
69
|
+
site_analytics:
|
|
70
|
+
id: '1234'
|
|
71
|
+
# Optional - choose between the `bsk-container` and `bsk-container-fluid` layout container
|
|
72
|
+
container: 'bsk-container'
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
To optionally add navigation menu items, add these lines to `_data/menus.yml`:
|
|
76
|
+
|
|
77
|
+
```
|
|
78
|
+
site_navigation_primary:
|
|
79
|
+
- url: '#'
|
|
80
|
+
title: 'Item'
|
|
81
|
+
|
|
82
|
+
site_navigation_launcher:
|
|
83
|
+
- url: 'https://www.bas.ac.uk'
|
|
84
|
+
title: BAS Home
|
|
85
|
+
weight: 1
|
|
86
|
+
- url: 'https://example.com'
|
|
87
|
+
title: Related service
|
|
88
|
+
weight: 3
|
|
89
|
+
```
|
|
39
90
|
|
|
91
|
+
#### Standard page
|
|
40
92
|
|
|
93
|
+
To create a page in an application or website based on the standard BAS page structure, create an application layout
|
|
94
|
+
(e.g. `_layouts/app.html`) with the following:
|
|
41
95
|
|
|
96
|
+
```
|
|
97
|
+
---
|
|
98
|
+
layout: layouts/bas-style-kit/bsk--standard.html
|
|
99
|
+
---
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
To base all pages this layout add these lines to your `_config.yml` file:
|
|
103
|
+
|
|
104
|
+
```yml
|
|
42
105
|
defaults:
|
|
43
106
|
-
|
|
44
107
|
scope:
|
|
45
108
|
# An empty string here means all files in the project
|
|
46
109
|
path: ""
|
|
47
110
|
values:
|
|
48
|
-
layout: "
|
|
111
|
+
layout: "app"
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
#### Use a page pattern
|
|
115
|
+
|
|
116
|
+
To create a page in an application or website based on a [page design pattern](#page-patterns), create a view
|
|
117
|
+
(e.g. `views/error.pug`) with the following:
|
|
118
|
+
|
|
119
|
+
```html
|
|
120
|
+
---
|
|
121
|
+
layout: views/bas-style-kit/[page-pattern]
|
|
122
|
+
---
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
Where `[page-pattern]` in the extends value is the name of a page pattern, for example:
|
|
126
|
+
|
|
127
|
+
```html
|
|
128
|
+
---
|
|
129
|
+
layout: views/bas-style-kit/bsk--page-not-found
|
|
130
|
+
---
|
|
131
|
+
```
|
|
49
132
|
|
|
50
133
|
### Patterns
|
|
51
134
|
|
|
@@ -54,7 +137,10 @@ For example, information to show when a service is unavailable, formatting dates
|
|
|
54
137
|
username in a consistent way. See the [Style Kit documentation](https://style-kit.web.bas.ac.uk/patterns) for more
|
|
55
138
|
information.
|
|
56
139
|
|
|
57
|
-
These patterns are implemented by this theme based on the reference examples included in the Style Kit.
|
|
140
|
+
These patterns are implemented by this theme based on the reference examples included in the Style Kit. These
|
|
141
|
+
include patterns for:
|
|
142
|
+
|
|
143
|
+
* [pages](#page-patterns) - standalone pages designed to be used without customisation, defined as [Views](#views)
|
|
58
144
|
|
|
59
145
|
#### Page patterns
|
|
60
146
|
|
|
@@ -87,133 +173,228 @@ Optionally, use page content for:
|
|
|
87
173
|
* contact information
|
|
88
174
|
* details of alternative services
|
|
89
175
|
|
|
176
|
+
### Using custom CSS/JS
|
|
90
177
|
|
|
178
|
+
Support is provided for loading additional CSS an/or JavaScript resources, such as application or website specific
|
|
179
|
+
styling or interactivity, either as references to files.
|
|
91
180
|
|
|
181
|
+
This support is available in all layouts which inherit from the `bsk--basic.html` layout.
|
|
92
182
|
|
|
93
|
-
|
|
183
|
+
For file resources, variables are provided for adding URLs and optional SRI values. Files will be included in the
|
|
184
|
+
relevant block automatically, after the Style Kit's own resources if a Style Kit layout is used.
|
|
94
185
|
|
|
95
|
-
|
|
186
|
+
* CSS resources are outputted at the end of the `<head>` element
|
|
187
|
+
* JS resources are outputted at the end of the `<body>` element
|
|
96
188
|
|
|
97
|
-
|
|
189
|
+
Add these lines to your `_config.yml` file:
|
|
98
190
|
|
|
99
|
-
|
|
100
|
-
|
|
191
|
+
```yml
|
|
192
|
+
bas_style_kit_jekyll_theme:
|
|
193
|
+
attributes:
|
|
194
|
+
site_styles:
|
|
195
|
+
-
|
|
196
|
+
href: '/css/main.css'
|
|
197
|
+
type: 'local'
|
|
198
|
+
site_scripts:
|
|
199
|
+
-
|
|
200
|
+
href: 'https://example.com/js/example.js'
|
|
201
|
+
integrity: 'abc123'
|
|
202
|
+
type: 'remote'
|
|
203
|
+
```
|
|
101
204
|
|
|
102
|
-
|
|
205
|
+
#### Resource objects
|
|
103
206
|
|
|
104
|
-
|
|
105
|
-
---
|
|
106
|
-
layout: views/bas-style-kit/page-not-found
|
|
107
|
-
---
|
|
108
|
-
```
|
|
207
|
+
Resource objects have the following properties:
|
|
109
208
|
|
|
110
|
-
|
|
111
|
-
|
|
209
|
+
| Property | Data Type | Required | Allowed Values | Example Value |
|
|
210
|
+
| ----------- | --------- | -------- | ------------------- | ------------------------------------------------------ |
|
|
211
|
+
| `href` | String | Yes | Any URL | `/css/app.css` / `https://example.com/js/app.js` |
|
|
212
|
+
| `type` | String | Yes | `local` or `remote` | `local` |
|
|
213
|
+
| `integrity` | String | No | Any SRI value | `sha256-ClILH8AIH4CkAybtlKhzqqQUYR4eSDiNTK5LIWfF4qQ=` |
|
|
112
214
|
|
|
113
|
-
|
|
215
|
+
The `integrity` property is used to specify a
|
|
216
|
+
[Subresource Integrity (SRI)](https://developer.mozilla.org/en-US/docs/Web/Security/Subresource_Integrity) value for
|
|
217
|
+
a resource. If specified an `integrity` attribute and will be added to the generated markup. A `crossorigin`
|
|
218
|
+
attribute will also be added for
|
|
219
|
+
[Cross-Origin Resource Sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) support with a
|
|
220
|
+
hard-coded, `anonymous`, value.
|
|
114
221
|
|
|
115
|
-
|
|
222
|
+
### Navigation menu items
|
|
116
223
|
|
|
117
|
-
|
|
118
|
-
|
|
224
|
+
When using the `bsk--standard.html` layout, a [navbar](https://style-kit.web.bas.ac.uk/components/navbar/) is included
|
|
225
|
+
as part of the 'standard header', which consists of a cookie banner, navbar and site development phase banner.
|
|
119
226
|
|
|
120
|
-
|
|
227
|
+
This navbar consists of three menus (and other elements, documented elsewhere):
|
|
121
228
|
|
|
122
|
-
|
|
123
|
-
|
|
229
|
+
1. a primary navigation menu - aligned left, after [brand elements](#navigation-branding)
|
|
230
|
+
2. a secondary navigation menu - aligned right, before the launcher menu
|
|
231
|
+
3. a navigation launcher menu - aligned right, after the secondary navigation menu
|
|
124
232
|
|
|
125
|
-
|
|
233
|
+
The navigation launcher is a restricted menu, used to link to other BAS websites and applications. By default it
|
|
234
|
+
contains links to the [BAS public website](https://www.bas.ac.uk) and the [BAS data catalogue](https://data.bas.ac.uk).
|
|
235
|
+
Other websites and applications can be added as well where relevant.
|
|
126
236
|
|
|
127
|
-
|
|
128
|
-
* [`html`](/docs/layout/html.md)
|
|
237
|
+
The primary and secondary navigation menu's support:
|
|
129
238
|
|
|
130
|
-
|
|
239
|
+
* [navbar items](https://style-kit.web.bas.ac.uk/components/navbar/#item)
|
|
240
|
+
* [navbar drop-down menus](https://style-kit.web.bas.ac.uk/components/navbar/#drop-down-menus)
|
|
241
|
+
* [navbar drop-down menu items](https://style-kit.web.bas.ac.uk/components/navbar/#drop-down-menus)
|
|
131
242
|
|
|
132
|
-
|
|
133
|
-
* [`bsk--standard`](/docs/layout/bsk--standard.md)
|
|
134
|
-
* [`bsk--standard-page`](/docs/layout/bsk--standard-page.md)
|
|
243
|
+
The navigation launcher menu, which is implemented as a drop-down menu, supports:
|
|
135
244
|
|
|
136
|
-
|
|
245
|
+
* [navbar drop-down menu items](https://style-kit.web.bas.ac.uk/components/navbar/#drop-down-menus)
|
|
137
246
|
|
|
138
|
-
|
|
139
|
-
|
|
247
|
+
All navigation menus are implemented using the [Jekyll menus](https://github.com/forestryio/jekyll-menus) plugin.
|
|
248
|
+
|
|
249
|
+
* primary navigation menu items should be added to the `site_navigation_primary` menu
|
|
250
|
+
* secondary navigation menu items should be added to the `site_navigation_secondary` menu
|
|
251
|
+
* navigation launcher menu items should be added to the `site_navigation_launcher` menu
|
|
252
|
+
|
|
253
|
+
**Note:** Menu items are only recursed once, deeper objects will be ignored.
|
|
254
|
+
|
|
255
|
+
### Navigation branding
|
|
256
|
+
|
|
257
|
+
[Navbars](https://style-kit.web.bas.ac.uk/components/navbar/) are also used to display the name/identity of a website
|
|
258
|
+
or application, to remind users where they are. These elements are referred to as 'brand' elements within the Style Kit.
|
|
259
|
+
|
|
260
|
+
In the 'standard header', navbar brand elements are shown on the far left.
|
|
261
|
+
|
|
262
|
+
Supported brand elements:
|
|
263
|
+
|
|
264
|
+
* [brand text](https://style-kit.web.bas.ac.uk/components/navbar/#brand-text) - set using the
|
|
265
|
+
`bas_style_kit_jekyll_theme.attributes.site_brand.text` config variable
|
|
266
|
+
* [brand image](https://style-kit.web.bas.ac.uk/components/navbar/#brand-image) - set using the
|
|
267
|
+
`bas_style_kit_jekyll_theme.attributes.site_brand.img` config variable
|
|
268
|
+
|
|
269
|
+
Brand elements can be used together or individually, with fix classes applied automatically as needed.
|
|
270
|
+
|
|
271
|
+
Brand elements are linked to a location specified by the `bas_style_kit_jekyll_theme.attributes.site_brand.href` config
|
|
272
|
+
variable, which should be the index of each website or application (i.e. `/`).
|
|
273
|
+
|
|
274
|
+
### Site development phase
|
|
275
|
+
|
|
276
|
+
The site development phase reflects the stage of development for a website or application, e.g. alpha or live. They are
|
|
277
|
+
described in the Style Kit [here](https://style-kit.web.bas.ac.uk/core/colours/#development-phase-colours).
|
|
278
|
+
|
|
279
|
+
For websites or applications that are not firmly in the 'live' phase, a banner should be shown to inform users and
|
|
280
|
+
request feedback. This forms part of the 'standard header' of cookie banner, navbar and site development phase banner.
|
|
281
|
+
|
|
282
|
+
In these templates, the `bas_style_kit_jekyll_theme.attributes.site_development_phase` config variable is used to
|
|
283
|
+
specify the current phase for a website or application. When using the `bsk--standard.html`layout, a banner will be
|
|
284
|
+
shown automatically based on this variable.
|
|
285
|
+
|
|
286
|
+
To disable this banner, set the `bas_style_kit_jekyll_theme.attributes.site_development_phase` config variable to
|
|
287
|
+
`live-stable`. This isn't a real phase but separates a newly released website or application from something more mature.
|
|
140
288
|
|
|
141
289
|
For example:
|
|
142
290
|
|
|
291
|
+
```yml
|
|
292
|
+
bas_style_kit_jekyll_theme:
|
|
293
|
+
attributes:
|
|
294
|
+
site_development_phase: 'alpha'
|
|
143
295
|
```
|
|
144
|
-
---
|
|
145
|
-
layout: bas-style-kit/bsk--standard
|
|
146
|
-
main_content_classes: bsk-pattern-page-not-found
|
|
147
|
-
---
|
|
148
296
|
|
|
149
|
-
|
|
297
|
+
#### Experimental development phase
|
|
298
|
+
|
|
299
|
+
Alternatively, the `bas_style_kit_jekyll_theme.attributes.site_development_phase` config variable can be set to
|
|
300
|
+
`experimental` to indicate where an website or application is used for staging or other development/testing activities.
|
|
301
|
+
|
|
302
|
+
For example:
|
|
303
|
+
|
|
304
|
+
```yml
|
|
305
|
+
bas_style_kit_jekyll_theme:
|
|
306
|
+
attributes:
|
|
307
|
+
site_development_phase: 'experimental'
|
|
150
308
|
```
|
|
151
309
|
|
|
152
|
-
###
|
|
310
|
+
### Website analytics
|
|
153
311
|
|
|
154
|
-
|
|
312
|
+
To include the Google Analytics universal tracking library (gtag), set the
|
|
313
|
+
`bas_style_kit_jekyll_theme.attributes.site_analytics.id` property to relevant Google Analytics property ID.
|
|
155
314
|
|
|
156
|
-
|
|
157
|
-
both their content and structure.
|
|
315
|
+
**Note:** When used, the anonymise IP option in Google Analytics is enabled by default.
|
|
158
316
|
|
|
159
|
-
|
|
317
|
+
For example:
|
|
160
318
|
|
|
161
|
-
|
|
319
|
+
```yml
|
|
320
|
+
bas_style_kit_jekyll_theme:
|
|
321
|
+
attributes:
|
|
322
|
+
site_analaytics:
|
|
323
|
+
id: '123abc'
|
|
324
|
+
```
|
|
162
325
|
|
|
163
|
-
|
|
164
|
-
`bas-style-kit/body.html`.
|
|
326
|
+
## Components
|
|
165
327
|
|
|
166
|
-
|
|
328
|
+
Components in these templates are structured according to Jekyll's conventions (e.g. layouts in `_layouts/`). They are
|
|
329
|
+
also namespaced in a `bas-style-kit` directory (e.g. `_layouts/bas-style-kit/`). Components that are specific to the
|
|
330
|
+
Style Kit are prefixed with `bsk--`.
|
|
167
331
|
|
|
168
|
-
|
|
169
|
-
* [`body`](/docs/include/body.md)
|
|
170
|
-
* [`toc`](/docs/include/toc.md)
|
|
332
|
+
### Views
|
|
171
333
|
|
|
172
|
-
|
|
334
|
+
Views are used for implementing [page patterns](#page-patterns). They are essentially layouts but with predefined page
|
|
335
|
+
content relevant to each pattern.
|
|
173
336
|
|
|
174
|
-
|
|
175
|
-
* [`bsk-body`](/docs/include/bsk-body.md)
|
|
176
|
-
* [`bsk-body--standard`](/docs/include/bsk-body--standard.md)
|
|
337
|
+
Within Jekyll, views are implemented as layouts. To use a view, create a page with the relevant 'view' layout.
|
|
177
338
|
|
|
178
|
-
|
|
339
|
+
```
|
|
340
|
+
---
|
|
341
|
+
layout: views/bas-style-kit/page-not-found
|
|
342
|
+
---
|
|
343
|
+
```
|
|
179
344
|
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
345
|
+
Views for some pattern variants can be used as-is, others require variables or page content to be set as well. See the
|
|
346
|
+
[Page patterns](#page-patterns) section for more information.
|
|
347
|
+
|
|
348
|
+
### Layouts
|
|
184
349
|
|
|
185
|
-
|
|
350
|
+
Refer to [Jekyll's documentation](https://jekyllrb.com/docs/layouts/) for general information.
|
|
186
351
|
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
* [`bsk-body--back-to-top`](/docs/include/bsk-body--back-to-top.md)
|
|
190
|
-
* [`bsk-body--standard-header`](/docs/include/bsk-body--standard-header.md)
|
|
191
|
-
* [`bsk-body--standard-footer`](/docs/include/bsk-body--standard-footer.md)
|
|
192
|
-
* [`bsk-body--page-header`](/docs/include/bsk-body--page-header.md)
|
|
193
|
-
* [`bsk-body--toc`](/docs/include/bsk-body--toc.md)
|
|
352
|
+
Layouts are 'base' templates from which views or other layouts inherit. Layouts in this theme are hierarchical, with
|
|
353
|
+
each layout extending the last in this order:
|
|
194
354
|
|
|
195
|
-
|
|
355
|
+
* `blank.html`: lowest level layout, intentionally as minimal as possible and not intended for direct use, unless
|
|
356
|
+
non-HTML output is needed
|
|
357
|
+
* `html.html`: defines a minimal, accessible, HTML5 structure with some recommended best practices for cross-platform
|
|
358
|
+
compatibility
|
|
359
|
+
* `bsk--base.html`: intentionally implements the BAS Style Kit as minimally as possible and not intended for direct use,
|
|
360
|
+
unless the bsk_standard.j2 layout is unsuitable
|
|
361
|
+
* `bsk--standard.html`: defines an opinionated, conventional, page layout with a 'standard' header/footer, recommended
|
|
362
|
+
as a base for application/website layouts
|
|
363
|
+
* `bsk--standard-page.html`: defines an opinionated, conventional, content page layout, recommended as a base for
|
|
364
|
+
content type websites, such as documentation
|
|
196
365
|
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
366
|
+
For example:
|
|
367
|
+
|
|
368
|
+
```markdown
|
|
369
|
+
---
|
|
370
|
+
layout: bas-style-kit/html
|
|
371
|
+
---
|
|
202
372
|
|
|
203
|
-
|
|
373
|
+
Page content
|
|
374
|
+
```
|
|
204
375
|
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
* [`bsk-header--development-phase`](/docs/include/bsk-header--development-phase.md)
|
|
376
|
+
Layouts inheriting from the `bsk--standard` layout can add additional classes to the `#main-content` element by setting
|
|
377
|
+
the `main_content_classes` variable in each layout.
|
|
208
378
|
|
|
209
|
-
|
|
379
|
+
For example:
|
|
210
380
|
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
381
|
+
```markdown
|
|
382
|
+
---
|
|
383
|
+
layout: bas-style-kit/bsk--standard
|
|
384
|
+
main_content_classes: foo
|
|
385
|
+
---
|
|
386
|
+
|
|
387
|
+
Page content
|
|
388
|
+
```
|
|
389
|
+
|
|
390
|
+
### Includes
|
|
391
|
+
|
|
392
|
+
Refer to [Jekyll's documentation](https://jekyllrb.com/docs/includes/) for general information.
|
|
393
|
+
|
|
394
|
+
This theme uses includes extensively to give fine grained control over how elements such as the navbar behave, including
|
|
395
|
+
both their content and structure.
|
|
396
|
+
|
|
397
|
+
Includes are often used conditionally using a related configuration option, to be disabled more easily.
|
|
217
398
|
|
|
218
399
|
### Data files
|
|
219
400
|
|
|
@@ -224,12 +405,6 @@ This theme uses data files to define CSS and JavaScript resources to load and fo
|
|
|
224
405
|
All data files use the `.yml` (Yaml) extension and are namespaced using a `bas-style-kit/` directory - i.e. a data
|
|
225
406
|
element `foo` in the data file `bsk-vars.yml` is available as `site.data.bas-style-kit.bsk-vars.foo`.
|
|
226
407
|
|
|
227
|
-
#### Style Kit specific data files
|
|
228
|
-
|
|
229
|
-
* [bsk-css](/data-file/bsk-css.md)
|
|
230
|
-
* [bsk-js](/data-file/bsk-js.md)
|
|
231
|
-
* [bsk-vars](/data-file/bsk-vars.md)
|
|
232
|
-
|
|
233
408
|
### Variables
|
|
234
409
|
|
|
235
410
|
Refer to [Jekyll's documentation](https://jekyllrb.com/docs/variables/) for general information.
|
|
@@ -272,10 +447,67 @@ bas_style_kit_jekyll_theme:
|
|
|
272
447
|
back_to_top_anchor: '[value]'
|
|
273
448
|
```
|
|
274
449
|
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
*
|
|
278
|
-
|
|
450
|
+
These config options can be set at a page, collection or site level:
|
|
451
|
+
|
|
452
|
+
* `bas_style_kit_jekyll_theme.feature_flags.page.toc`
|
|
453
|
+
|
|
454
|
+
These config options should be changed or set for each website or application:
|
|
455
|
+
|
|
456
|
+
* `bas_style_kit_jekyll_theme.attributes.head_title.default`
|
|
457
|
+
* `bas_style_kit_jekyll_theme.attributes.head_title.appended`
|
|
458
|
+
* `bas_style_kit_jekyll_theme.attributes.head_description`
|
|
459
|
+
* `bas_style_kit_jekyll_theme.attributes.site_analytics.id`
|
|
460
|
+
* `bas_style_kit_jekyll_theme.attributes.site_brand.text`
|
|
461
|
+
* `bas_style_kit_jekyll_theme.attributes.site_development_phase`
|
|
462
|
+
* `bas_style_kit_jekyll_theme.attributes.site_feedback_href`
|
|
463
|
+
* `bas_style_kit_jekyll_theme.attributes.site_footer.legal_policies.cookies_href`
|
|
464
|
+
* `bas_style_kit_jekyll_theme.attributes.site_footer.legal_policies.copyright_href`
|
|
465
|
+
* `bas_style_kit_jekyll_theme.attributes.site_footer.legal_policies.privacy_href`
|
|
466
|
+
|
|
467
|
+
These config options may, but don't need to be, changed or set for each website or application:
|
|
468
|
+
|
|
469
|
+
* `bas_style_kit_jekyll_theme.attributes.container`
|
|
470
|
+
* `bas_style_kit_jekyll_theme.attributes.site_styles`
|
|
471
|
+
* `bas_style_kit_jekyll_theme.attributes.site_scripts`
|
|
472
|
+
* `bas_style_kit_jekyll_theme.attributes.head_favicon`
|
|
473
|
+
* `bas_style_kit_jekyll_theme.attributes.site_brand.img`
|
|
474
|
+
* `bas_style_kit_jekyll_theme.attributes.site_brand.href`
|
|
475
|
+
|
|
476
|
+
These config options do not normally, and should not, need to be changed or set:
|
|
477
|
+
|
|
478
|
+
* `bas_style_kit_jekyll_theme.attributes.site_back_to_top_target_href`
|
|
479
|
+
* `bas_style_kit_jekyll_theme.attributes.site_footer.ogl.href`
|
|
480
|
+
* `bas_style_kit_jekyll_theme.attributes.site_footer.ogl.version`
|
|
481
|
+
|
|
482
|
+
These config options must not be changed and should be treated as read only:
|
|
483
|
+
|
|
484
|
+
* `site.data.bas-style-kit.bsk-vars.theme_version`
|
|
485
|
+
* `site.data.bas-style-kit.bsk-vars.bsk_version`
|
|
486
|
+
|
|
487
|
+
| Config Option | Value Type | Allowed Values | Default Value | Notes |
|
|
488
|
+
| --------------------------------------------------------------------------------- | ---------- | ----------------------------------------------------------------------------------------------- | ------------------ | ---------------------------------------------------------- |
|
|
489
|
+
| `bas_style_kit_jekyll_theme.feature_flags.page.toc` | Boolean | `true` / `false` | `true` | Whether to show the table of contents in standard pages |
|
|
490
|
+
| `bas_style_kit_jekyll_theme.attributes.head_title.default` | String | Any string | 'site title' | Typically 1-3 words |
|
|
491
|
+
| `bas_style_kit_jekyll_theme.attributes.head_title.appended` | String | Any string | *None* | Typically 1-3 words |
|
|
492
|
+
| `bas_style_kit_jekyll_theme.attributes.head_description` | String | Any string | 'site description' | Typically 1-2 sentences |
|
|
493
|
+
| `bas_style_kit_jekyll_theme.attributes.site_analytics.id` | String | Google Analytics property ID | *None* | See [Site analytics](#site-analytics) |
|
|
494
|
+
| `bas_style_kit_jekyll_theme.attributes.site_brand.text` | String | Any string | 'site title' | Typically 1-3 words |
|
|
495
|
+
| `bas_style_kit_jekyll_theme.attributes.site_development_phase` | String | `discovery` / `alpha` / `beta` / `live` / `live-stable` / `retired` / `experimental` / `custom` | 'alpha' | See [Site development phase](#site-development-phase) |
|
|
496
|
+
| `bas_style_kit_jekyll_theme.attributes.site_feedback_href` | String | URL to feedback page or other content (e.g. model overlay) | '/feedback.html' | - |
|
|
497
|
+
| `bas_style_kit_jekyll_theme.attributes.site_footer.legal_policies.cookies_href` | String | URL to cookies legal policy | '/legal/cookies' | - |
|
|
498
|
+
| `bas_style_kit_jekyll_theme.attributes.site_footer.legal_policies.copyright_href` | String | URL to copyright legal policy | '/legal/copyright' | - |
|
|
499
|
+
| `bas_style_kit_jekyll_theme.attributes.site_footer.legal_policies.privacy_href` | String | URL to privacy legal policy | '/legal/privacy' | - |
|
|
500
|
+
| `bas_style_kit_jekyll_theme.attributes.container` | String | `fixed` / `fluid` | 'fixed' | - |
|
|
501
|
+
| `bas_style_kit_jekyll_theme.attributes.site_styles` | Array | Site style object | *Empty array* | See [Using custom CSS/JS](#using-custom-cssjs) |
|
|
502
|
+
| `bas_style_kit_jekyll_theme.attributes.site_scripts` | Array | Site script object | *Empty array* | See [Using custom CSS/JS](#using-custom-cssjs) |
|
|
503
|
+
| `bas_style_kit_jekyll_theme.attributes.head_favicon` | String | `default` | 'default' | The favicon to use, use 'default' the standard BAS favicon |
|
|
504
|
+
| `bas_style_kit_jekyll_theme.attributes.site_brand.img` | String | URL to image | *None* | See [Navigation menu branding](#navigation-menu-branding) |
|
|
505
|
+
| `bas_style_kit_jekyll_theme.attributes.site_brand.href` | String | URL to content | '/' | See [Navigation menu branding](#navigation-menu-branding) |
|
|
506
|
+
| `bas_style_kit_jekyll_theme.attributes.site_back_to_top_target_href` | String | CSS ID selector | '#site-top' | - |
|
|
507
|
+
| `bas_style_kit_jekyll_theme.attributes.site_footer.ogl.href` | String | URL to OGL information page | *As implemented* | - |
|
|
508
|
+
| `bas_style_kit_jekyll_theme.attributes.site_footer.ogl.version` | String | Any OGL version | *As implemented* | - |
|
|
509
|
+
| `site.data.bas-style-kit.bsk-vars.theme_version` | String | Any [SemVer](https://semver.org/) value | *As implemented* | - |
|
|
510
|
+
| `site.data.bas-style-kit.bsk-vars.bsk_version` | String | Any BAS Style Kit version | *As implemented* | - |
|
|
279
511
|
|
|
280
512
|
### Plugins
|
|
281
513
|
|
|
@@ -373,9 +605,7 @@ Before release:
|
|
|
373
605
|
|
|
374
606
|
1. create a release branch
|
|
375
607
|
2. remove `-develop` from the version in:
|
|
376
|
-
* `.gitlab-ci.yml`
|
|
377
608
|
* `jekyll-theme-bas-style-kit.gemspec`
|
|
378
|
-
* `docker-compose.yml`
|
|
379
609
|
* `_data/bsk_jekyll_vars.json`
|
|
380
610
|
3. build and push the app docker image [1]
|
|
381
611
|
4. if new config options have been set, update the usage section
|
|
@@ -389,9 +619,7 @@ Before release:
|
|
|
389
619
|
After release:
|
|
390
620
|
|
|
391
621
|
1. bump the version with `-develop` as a prefix in:
|
|
392
|
-
* `.gitlab-ci.yml`
|
|
393
622
|
* `jekyll-theme-bas-style-kit.gemspec`
|
|
394
|
-
* `docker-compose.yml`
|
|
395
623
|
* `_data/bsk_jekyll_vars.json`
|
|
396
624
|
2. push the app docker image [1]
|
|
397
625
|
3. commit changes, merge with master and close release branch
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
2
|
-
|
|
3
|
-
href: 'https://cdn.web.bas.ac.uk/bas-style-kit/0.
|
|
4
|
-
integrity: 'sha256-
|
|
3
|
+
href: 'https://cdn.web.bas.ac.uk/bas-style-kit/0.6.0-alpha/css/bas-style-kit.min.css'
|
|
4
|
+
integrity: 'sha256-YsP5zVtOhiEalahZCyQcl8vG7vyzUJ4aP/yGoPXGOZ0='
|
|
5
5
|
type: 'remote'
|
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
---
|
|
2
2
|
-
|
|
3
|
-
href: 'https://cdn.web.bas.ac.uk/
|
|
3
|
+
href: 'https://cdn.web.bas.ac.uk/libs/jquery/3.3.1/jquery-3.3.1.min.js'
|
|
4
4
|
integrity: 'sha256-FgpCb/KJQlLNfOu91ta32o/NMZxltwRo8QtmkMRdAu8='
|
|
5
5
|
type: 'remote'
|
|
6
6
|
-
|
|
7
|
-
href: 'https://cdn.web.bas.ac.uk/js-
|
|
7
|
+
href: 'https://cdn.web.bas.ac.uk/libs/js-cookie/2.1.3/js.cookie-2.1.3.min.js'
|
|
8
8
|
integrity: 'sha256-EareStqgZTnMUqLWtDkCa3SldvB8NPBY8u5C6ZUMWRc='
|
|
9
9
|
type: 'remote'
|
|
10
10
|
-
|
|
11
|
-
href: 'https://cdn.web.bas.ac.uk/bas-style-kit/0.
|
|
12
|
-
integrity: 'sha256-
|
|
11
|
+
href: 'https://cdn.web.bas.ac.uk/bas-style-kit/0.6.0-alpha/js/bas-style-kit.min.js'
|
|
12
|
+
integrity: 'sha256-pGW+MS4z0IRzUK+7MJrnpc/1FwbD0v0BdP4mvmMlJhw='
|
|
13
13
|
type: 'remote'
|
|
@@ -1,3 +1,3 @@
|
|
|
1
1
|
---
|
|
2
|
-
theme_version: "0.
|
|
3
|
-
bsk_version: "0.
|
|
2
|
+
theme_version: "0.9.0"
|
|
3
|
+
bsk_version: "0.6.0-alpha"
|
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.
|
|
4
|
+
version: 0.9.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Felix Fennell
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date:
|
|
11
|
+
date: 2019-07-02 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: jekyll
|