jekyll-theme-bas-style-kit 0.5.0 → 0.6.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 +25 -0
- data/README.md +116 -21
- data/_config.yml +1 -1
- data/_data/bas-style-kit/bsk-css.yml +2 -2
- data/_data/bas-style-kit/bsk-js.yml +2 -2
- data/_data/bas-style-kit/bsk-vars.yml +2 -2
- data/_data/menus.yml +1 -1
- data/_includes/bas-style-kit/bsk-body--standard.html +1 -1
- data/_includes/bas-style-kit/bsk-footer--back-to-top.html +1 -3
- data/_includes/bas-style-kit/bsk-head--favicon.html +11 -1
- data/_includes/bas-style-kit/bsk-header--cookie-notice.html +1 -3
- data/_layouts/views/bas-style-kit/bsk--page-not-found.html +10 -0
- data/_layouts/views/bas-style-kit/bsk--service-unavailable-basic.html +8 -0
- data/screenshot.png +0 -0
- metadata +4 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 54c4be6b3f545080f6b9a1732d0cb9ed6df145bd1e12bfd3bed99bd5d5d087f8
|
|
4
|
+
data.tar.gz: a499c53f7ce5ae7eddf776c21abf72ccad53ac450d4b8898b6051e5e3056a7dd
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 6b5fb5a4c2bff1760efb1e2add4f834d56cb2c0c558fff58b83e4ee9d99dbdfa08b10af8709cf541d2488058f085261f6d198604c0f6c0bd1d71187b94fa16fa
|
|
7
|
+
data.tar.gz: 67a8d3c47dde8f49ce089d0345da5a59cccb92cb314422c6c8ca35522af85393919493681c13e127737843490bb43f7ae3e421cadca6d580e87345aaaa3fa1e5
|
data/CHANGELOG.md
CHANGED
|
@@ -5,6 +5,31 @@ This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html
|
|
|
5
5
|
|
|
6
6
|
## [Unreleased][unreleased]
|
|
7
7
|
|
|
8
|
+
## 0.6.0 - 2018-09-18
|
|
9
|
+
|
|
10
|
+
### Changed [BREAKING!]
|
|
11
|
+
|
|
12
|
+
* Icon uses replaced with alternatives or removed where not needed due to the removal of Font Awesome
|
|
13
|
+
* Favicon attribute option changed, set `bas_style_kit_jekyll_theme.attributes.head_favicon` to `default` for the Style
|
|
14
|
+
Kit favicon, other values will be ignored and no favicon will be set
|
|
15
|
+
|
|
16
|
+
### Added
|
|
17
|
+
|
|
18
|
+
* Updated to Style Kit 0.5.0-alpha
|
|
19
|
+
* Implemented Style Kit Favicon
|
|
20
|
+
* Implemented 'page not found' pattern and support for design patterns generally
|
|
21
|
+
* Implemented 'Service unavailable (basic)' pattern
|
|
22
|
+
|
|
23
|
+
### Changed
|
|
24
|
+
|
|
25
|
+
* Updating order of navigation launcher items
|
|
26
|
+
* Improving Dockerfiles
|
|
27
|
+
* Improving internal test content
|
|
28
|
+
|
|
29
|
+
### Fixed
|
|
30
|
+
|
|
31
|
+
* Corrected link to issue tracker
|
|
32
|
+
|
|
8
33
|
## 0.5.0 - 2018-07-06
|
|
9
34
|
|
|
10
35
|
### Fixed
|
data/README.md
CHANGED
|
@@ -20,11 +20,11 @@ $ bundle
|
|
|
20
20
|
|
|
21
21
|
Or install it yourself as:
|
|
22
22
|
|
|
23
|
-
```
|
|
23
|
+
```shell
|
|
24
24
|
$ gem install jekyll-theme-bas-style-kit
|
|
25
25
|
```
|
|
26
26
|
|
|
27
|
-
|
|
27
|
+
Finally, to use the theme, add this line to your `_config.yml` file:
|
|
28
28
|
|
|
29
29
|
```yaml
|
|
30
30
|
theme: jekyll-theme-bas-style-kit
|
|
@@ -34,30 +34,112 @@ 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
|
-
###
|
|
38
|
-
|
|
39
|
-
This theme defines two types of layout:
|
|
37
|
+
### Quick start
|
|
40
38
|
|
|
41
|
-
|
|
42
|
-
* *non-generic* - implement the Style Kit either broadly or in more opinionated forms
|
|
39
|
+
#### Standard page
|
|
43
40
|
|
|
44
|
-
|
|
41
|
+
To base all pages on the `bsk--standard` layout, add the following to your `_config.yml` file:
|
|
45
42
|
|
|
46
|
-
|
|
47
|
-
|
|
43
|
+
```yml
|
|
44
|
+
# Content settings
|
|
45
|
+
#
|
|
48
46
|
|
|
49
|
-
To use a layout by default add the following to your `_config.yml`:
|
|
50
47
|
|
|
51
|
-
```yml
|
|
52
48
|
defaults:
|
|
53
49
|
-
|
|
54
50
|
scope:
|
|
55
|
-
#
|
|
51
|
+
# An empty string here means all files in the project
|
|
56
52
|
path: ""
|
|
57
53
|
values:
|
|
58
54
|
layout: "bas-style-kit/bsk--standard"
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
# Theme settings
|
|
58
|
+
#
|
|
59
|
+
|
|
60
|
+
bas_style_kit_jekyll_theme:
|
|
61
|
+
attributes:
|
|
62
|
+
head_title:
|
|
63
|
+
default: 'Example service'
|
|
64
|
+
appended: ' - Example service'
|
|
65
|
+
head_description: 'Service to act as an example'
|
|
66
|
+
site_brand:
|
|
67
|
+
text: 'Example service'
|
|
68
|
+
href: '/'
|
|
69
|
+
site_development_phase: 'beta'
|
|
70
|
+
# Optional - web analytics
|
|
71
|
+
site_analytics:
|
|
72
|
+
id: UA-64130716-27
|
|
73
|
+
# Optional - add a custom CSS file with a relative URL
|
|
74
|
+
site_styles:
|
|
75
|
+
-
|
|
76
|
+
href: '/css/main.css'
|
|
77
|
+
type: 'local'
|
|
59
78
|
```
|
|
60
79
|
|
|
80
|
+
### Patterns
|
|
81
|
+
|
|
82
|
+
Design patterns are used to demonstrate preferred ways to pass on information to users, or ask them for information.
|
|
83
|
+
For example, information to show when a service is unavailable, formatting dates consistently or asking users for their
|
|
84
|
+
username in a consistent way. See the [Style Kit documentation](https://style-kit.web.bas.ac.uk/patterns) for more
|
|
85
|
+
information.
|
|
86
|
+
|
|
87
|
+
These patterns are implemented by this theme based on the reference examples included in the Style Kit. These
|
|
88
|
+
include patterns for:
|
|
89
|
+
|
|
90
|
+
* **pages** - standalone pages designed to be used without customisation, defined as [Views](#views)
|
|
91
|
+
|
|
92
|
+
### Using custom CSS/JS
|
|
93
|
+
|
|
94
|
+
...
|
|
95
|
+
|
|
96
|
+
### Navigation menu items
|
|
97
|
+
|
|
98
|
+
...
|
|
99
|
+
|
|
100
|
+
### Navigation branding
|
|
101
|
+
|
|
102
|
+
...
|
|
103
|
+
|
|
104
|
+
### Site development phase
|
|
105
|
+
|
|
106
|
+
...
|
|
107
|
+
|
|
108
|
+
### Website analytics
|
|
109
|
+
|
|
110
|
+
...
|
|
111
|
+
|
|
112
|
+
### Views
|
|
113
|
+
|
|
114
|
+
Views provide complete pages to implement page [Patterns](#patterns).
|
|
115
|
+
|
|
116
|
+
All views use the `.html` extension. I.e. the view `page-not-found` should be referenced as `page-not-found.html`.
|
|
117
|
+
|
|
118
|
+
All views are namespaced using a `bas-style-kit/` directory - i.e. the view `page-not-found.html` should be referenced
|
|
119
|
+
as `bas-style-kit/page-not-found.html`.
|
|
120
|
+
|
|
121
|
+
Within Jekyll views are implemented as layouts. To implement a view create a page with the relevant 'view layout.
|
|
122
|
+
|
|
123
|
+
```
|
|
124
|
+
---
|
|
125
|
+
layout: views/bas-style-kit/page-not-found
|
|
126
|
+
---
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
**Note:** You do not need to add any page content.
|
|
130
|
+
|
|
131
|
+
### Layouts
|
|
132
|
+
|
|
133
|
+
This theme defines two types of layout:
|
|
134
|
+
|
|
135
|
+
* *generic* - non Style Kit specific intended for atypical content
|
|
136
|
+
* *non-generic* - implement the Style Kit either broadly or in more opinionated forms
|
|
137
|
+
|
|
138
|
+
All layouts use the `.html` extension. I.e. the layout `blank` should be referenced as `blank.html`.
|
|
139
|
+
|
|
140
|
+
All layouts are namespaced using a `bas-style-kit/` directory - i.e. the layout `blank.html` should be referenced as
|
|
141
|
+
`bas-style-kit/blank.html`.
|
|
142
|
+
|
|
61
143
|
#### Generic layouts
|
|
62
144
|
|
|
63
145
|
* [`blank`](/docs/layout/blank.md)
|
|
@@ -69,6 +151,22 @@ defaults:
|
|
|
69
151
|
* [`bsk--standard`](/docs/layout/bsk--standard.md)
|
|
70
152
|
* [`bsk--standard-page`](/docs/layout/bsk--standard-page.md)
|
|
71
153
|
|
|
154
|
+
**Note:** The `bsk--stardard-page` layout is only available in this theme.
|
|
155
|
+
|
|
156
|
+
Layouts inheriting from the `bsk--standard` layout can add additional classes to the `#main-content` element by setting
|
|
157
|
+
the `main_content_classes` variable in each layout.
|
|
158
|
+
|
|
159
|
+
For example:
|
|
160
|
+
|
|
161
|
+
```
|
|
162
|
+
---
|
|
163
|
+
layout: bas-style-kit/bsk--standard
|
|
164
|
+
main_content_classes: bsk-pattern-page-not-found
|
|
165
|
+
---
|
|
166
|
+
|
|
167
|
+
<h1 class="bsk-page-header">Page not found</h1>
|
|
168
|
+
```
|
|
169
|
+
|
|
72
170
|
### Includes
|
|
73
171
|
|
|
74
172
|
Refer to [Jekyll's documentation](https://jekyllrb.com/docs/include/) for general information.
|
|
@@ -310,18 +408,15 @@ $ docker-compose push
|
|
|
310
408
|
[2]
|
|
311
409
|
|
|
312
410
|
```shell
|
|
313
|
-
|
|
314
|
-
$
|
|
315
|
-
$
|
|
316
|
-
# remove 'entrypoint: ash' from the app service in /docker-compose.yml
|
|
411
|
+
$ docker-compose run --entrypoint=[] app ash
|
|
412
|
+
$ gem build jekyll-theme-bas-style-kit.gemspec
|
|
413
|
+
$ gem push jekyll-theme-bas-style-kit-*.gem
|
|
317
414
|
```
|
|
318
415
|
|
|
319
|
-
**Note:** Add `entrypoint: ash` to the `app` service in `docker-compose.yml` to run these commands
|
|
320
|
-
|
|
321
416
|
## Issue tracking
|
|
322
417
|
|
|
323
|
-
This project uses [issue tracking](https://
|
|
324
|
-
|
|
418
|
+
This project uses [issue tracking](https://trello.com/b/0Mhzizpk/bas-style-kit) to manage development of new
|
|
419
|
+
features/improvements and reporting bugs.
|
|
325
420
|
|
|
326
421
|
**Note:** Read & write access to this issue tracker is restricted. Contact the project maintainer to request access.
|
|
327
422
|
|
data/_config.yml
CHANGED
|
@@ -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.5.0-alpha/css/bas-style-kit.min.css'
|
|
4
|
+
integrity: 'sha256-nWXiUZmHWfWNh1kXmFmOIeYXTJQL0BYUcuN0lZH+YRk='
|
|
5
5
|
type: 'remote'
|
|
@@ -8,6 +8,6 @@
|
|
|
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.5.0-alpha/js/bas-style-kit.min.js'
|
|
12
|
+
integrity: 'sha256-hWgpo+9I3Nv3OcGXddejrZZNUNEzKBxaoxO/4IYImoM='
|
|
13
13
|
type: 'remote'
|
|
@@ -1,3 +1,3 @@
|
|
|
1
1
|
---
|
|
2
|
-
theme_version: "0.
|
|
3
|
-
bsk_version: "0.
|
|
2
|
+
theme_version: "0.6.0"
|
|
3
|
+
bsk_version: "0.5.0-alpha"
|
data/_data/menus.yml
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
{% if site.bas_style_kit_jekyll_theme.feature_flags.site.standard_header == true %}
|
|
6
6
|
{% include bas-style-kit/bsk-body--standard-header.html %}
|
|
7
7
|
{% endif %}
|
|
8
|
-
<main class="{% if site.bas_style_kit_jekyll_theme.attributes.container == 'fixed' %}bsk-container{% elsif site.bas_style_kit_jekyll_theme.attributes.container == 'fluid' %}bsk-container-fluid{% endif %}" id="site-content">
|
|
8
|
+
<main class="{% if site.bas_style_kit_jekyll_theme.attributes.container == 'fixed' %}bsk-container{% elsif site.bas_style_kit_jekyll_theme.attributes.container == 'fluid' %}bsk-container-fluid{% endif %} {{ layout.main_content_classes }}" id="site-content">
|
|
9
9
|
{{ content }}
|
|
10
10
|
</main>
|
|
11
11
|
{% if site.bas_style_kit_jekyll_theme.feature_flags.site.standard_footer == true %}
|
|
@@ -1,5 +1,3 @@
|
|
|
1
1
|
<div class="bsk-footer-back-to-top">
|
|
2
|
-
<a href="{{ site.bas_style_kit_jekyll_theme.attributes.site_back_to_top_target_href }}">
|
|
3
|
-
<i class="fa fa-fw fa-chevron-up" aria-hidden="true"></i> Back to top
|
|
4
|
-
</a>
|
|
2
|
+
<a href="{{ site.bas_style_kit_jekyll_theme.attributes.site_back_to_top_target_href }}"> Back to top</a>
|
|
5
3
|
</div>
|
|
@@ -1,2 +1,12 @@
|
|
|
1
1
|
<!-- Favicon and app icons -->
|
|
2
|
-
{% if site.bas_style_kit_jekyll_theme.attributes.head_favicon
|
|
2
|
+
{% if site.bas_style_kit_jekyll_theme.attributes.head_favicon == 'default' %}
|
|
3
|
+
<link rel="apple-touch-icon" sizes="180x180" href="https://cdn.web.bas.ac.uk/bas-style-kit/{{ site.data.bas-style-kit.bsk-vars.bsk_version }}/img/favicon/apple-touch-icon.png">
|
|
4
|
+
<link rel="icon" type="image/png" sizes="32x32" href="https://cdn.web.bas.ac.uk/bas-style-kit/{{ site.data.bas-style-kit.bsk-vars.bsk_version }}/img/favicon/favicon-32x32.png">
|
|
5
|
+
<link rel="icon" type="image/png" sizes="16x16" href="https://cdn.web.bas.ac.uk/bas-style-kit/{{ site.data.bas-style-kit.bsk-vars.bsk_version }}/img/favicon/favicon-16x16.png">
|
|
6
|
+
<link rel="manifest" href="https://cdn.web.bas.ac.uk/bas-style-kit/{{ site.data.bas-style-kit.bsk-vars.bsk_version }}/img/favicon/site.webmanifest">
|
|
7
|
+
<link rel="mask-icon" href="https://cdn.web.bas.ac.uk/bas-style-kit/{{ site.data.bas-style-kit.bsk-vars.bsk_version }}/img/favicon/safari-pinned-tab.svg" color="#222222">
|
|
8
|
+
<link rel="shortcut icon" href="https://cdn.web.bas.ac.uk/bas-style-kit/{{ site.data.bas-style-kit.bsk-vars.bsk_version }}/img/favicon/favicon.ico">
|
|
9
|
+
<meta "name"="msapplication-TileColor" content="#222222">
|
|
10
|
+
<meta "name"="msapplication-config" content="https://cdn.web.bas.ac.uk/bas-style-kit/{{ site.data.bas-style-kit.bsk-vars.bsk_version }}/img/favicon/browserconfig.xml">
|
|
11
|
+
<meta "name"="theme-color" content="#222222">
|
|
12
|
+
{% endif %}
|
|
@@ -1,9 +1,7 @@
|
|
|
1
1
|
<div class="bsk-fix-alert-static-top-{{ site.bas_style_kit_jekyll_theme.attributes.container }}-container-wrapper">
|
|
2
2
|
<div class="{{ bsk_attributes_container_class }}">
|
|
3
3
|
<div class="bsk-alert bsk-alert-static-top bsk-alert-dismissible bsk-alert-solid bsk-alert-cookie-notice" data-bsk-role='cookie-notice'>
|
|
4
|
-
<button class="bsk-close" type="button" data-dismiss="alert" aria-label="Close">
|
|
5
|
-
<i class="fa fa-times" aria-hidden="true"></i>
|
|
6
|
-
</button>
|
|
4
|
+
<button class="bsk-close" type="button" data-dismiss="alert" aria-label="Close">×</button>
|
|
7
5
|
This website uses cookies to help us make it better -
|
|
8
6
|
<a class="bsk-alert-link" href="{{ site.bas_style_kit_jekyll_theme.attributes.site_footer.legal_policies.cookies_href }}">find out more</a>
|
|
9
7
|
</div>
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
---
|
|
2
|
+
layout: bas-style-kit/bsk--standard
|
|
3
|
+
main_content_classes: bsk-pattern-page-not-found
|
|
4
|
+
title: Page not found
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
<h1 class="bsk-page-header">Page not found</h1>
|
|
8
|
+
<p>If you typed the web address, check it is correct.</p>
|
|
9
|
+
<p>If you pasted the web address, check you copied the entire address.</p>
|
|
10
|
+
<p>If the web address is correct or you selected a link or button, <a href="{{ site.bas_style_kit_jekyll_theme.attributes.site_feedback_href }}">contact us</a> to let us know.</p>
|
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.
|
|
4
|
+
version: 0.6.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: 2018-
|
|
11
|
+
date: 2018-09-18 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: jekyll
|
|
@@ -170,6 +170,8 @@ files:
|
|
|
170
170
|
- _layouts/bas-style-kit/bsk--standard-page.html
|
|
171
171
|
- _layouts/bas-style-kit/bsk--standard.html
|
|
172
172
|
- _layouts/bas-style-kit/html.html
|
|
173
|
+
- _layouts/views/bas-style-kit/bsk--page-not-found.html
|
|
174
|
+
- _layouts/views/bas-style-kit/bsk--service-unavailable-basic.html
|
|
173
175
|
- _sass/main.scss
|
|
174
176
|
- assets/empty
|
|
175
177
|
- screenshot.png
|