jekyll-theme-cayman 0.1.1 → 0.2.0
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.
- checksums.yaml +4 -4
- data/README.md +15 -8
- data/_includes/head-custom-google-analytics.html +10 -0
- data/_includes/head-custom.html +9 -0
- data/_layouts/default.html +12 -18
- data/_sass/cayman.scss +4 -0
- data/_sass/jekyll-theme-cayman.scss +33 -1
- metadata +22 -14
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 89749bdfd9ed875f2dd38c2d3db82a05430f324254f26ab020f940dfc8540e60
|
|
4
|
+
data.tar.gz: f4099a802bd7fa7b13aa8c229f226d1e7d2166759a357f53c099eb1822ddd129
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 53e4a441c6e8fa4f6fb0aaa3dc741077ab166e05a7b411d426cdd00518340418df94e8b96543004095a8c9f5224289117b9c738960ec13be37348637d0d17f58
|
|
7
|
+
data.tar.gz: 9c0e53440e85633f77e2646092392a5246dd95990583a8918e1e68d667bda0a367731e353ee716c63ad0c812f67f0e5671ecf970263304a8982d4c882f7c1f02
|
data/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# The Cayman theme
|
|
2
2
|
|
|
3
|
-
[](https://github.com/pages-themes/cayman/actions/workflows/ci.yaml) [](https://badge.fury.io/rb/jekyll-theme-cayman)
|
|
4
4
|
|
|
5
5
|
*Cayman is a Jekyll theme for GitHub Pages. You can [preview the theme to see what it looks like](http://pages-themes.github.io/cayman), or even [use it today](#usage).*
|
|
6
6
|
|
|
@@ -13,7 +13,9 @@ To use the Cayman theme:
|
|
|
13
13
|
1. Add the following to your site's `_config.yml`:
|
|
14
14
|
|
|
15
15
|
```yml
|
|
16
|
-
|
|
16
|
+
remote_theme: pages-themes/cayman@v0.2.0
|
|
17
|
+
plugins:
|
|
18
|
+
- jekyll-remote-theme # add this line to the plugins list if you already have one
|
|
17
19
|
```
|
|
18
20
|
|
|
19
21
|
2. Optionally, if you'd like to preview your site on your computer, add the following to your site's `Gemfile`:
|
|
@@ -36,7 +38,7 @@ description: [A short description of your site's purpose]
|
|
|
36
38
|
Additionally, you may choose to set the following optional variables:
|
|
37
39
|
|
|
38
40
|
```yml
|
|
39
|
-
show_downloads: ["true" or "false" to indicate whether to provide a download URL]
|
|
41
|
+
show_downloads: ["true" or "false" (unquoted) to indicate whether to provide a download URL]
|
|
40
42
|
google_analytics: [Your Google Analytics tracking ID]
|
|
41
43
|
```
|
|
42
44
|
|
|
@@ -60,10 +62,15 @@ If you'd like to add your own custom styles:
|
|
|
60
62
|
|
|
61
63
|
If you'd like to change the theme's HTML layout:
|
|
62
64
|
|
|
63
|
-
1. [
|
|
64
|
-
2.
|
|
65
|
-
3.
|
|
66
|
-
4.
|
|
65
|
+
1. For some changes such as a custom `favicon`, you can add custom files in your local `_includes` folder. The files [provided with the theme](https://github.com/pages-themes/cayman/tree/master/_includes) provide a starting point and are included by the [original layout template](https://github.com/pages-themes/cayman/blob/master/_layouts/default.html).
|
|
66
|
+
2. For more extensive changes, [copy the original template](https://github.com/pages-themes/cayman/blob/master/_layouts/default.html) from the theme's repository<br />(*Pro-tip: click "raw" to make copying easier*)
|
|
67
|
+
3. Create a file called `/_layouts/default.html` in your site
|
|
68
|
+
4. Paste the default layout content copied in the first step
|
|
69
|
+
5. Customize the layout as you'd like
|
|
70
|
+
|
|
71
|
+
### Customizing Google Analytics code
|
|
72
|
+
|
|
73
|
+
Google has released several iterations to their Google Analytics code over the years since this theme was first created. If you would like to take advantage of the latest code, paste it into `_includes/head-custom-google-analytics.html` in your Jekyll site.
|
|
67
74
|
|
|
68
75
|
### Overriding GitHub-generated URLs
|
|
69
76
|
|
|
@@ -106,4 +113,4 @@ If you'd like to preview the theme locally (for example, in the process of propo
|
|
|
106
113
|
|
|
107
114
|
### Running tests
|
|
108
115
|
|
|
109
|
-
The theme contains a minimal test suite, to ensure a site with the theme would build successfully. To run the tests, simply run `script/cibuild`. You'll need to run `script/bootstrap`
|
|
116
|
+
The theme contains a minimal test suite, to ensure a site with the theme would build successfully. To run the tests, simply run `script/cibuild`. You'll need to run `script/bootstrap` once before the test script will work.
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
{% if site.google_analytics %}
|
|
2
|
+
<script>
|
|
3
|
+
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
|
4
|
+
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
|
5
|
+
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
|
6
|
+
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
|
|
7
|
+
ga('create', '{{ site.google_analytics }}', 'auto');
|
|
8
|
+
ga('send', 'pageview');
|
|
9
|
+
</script>
|
|
10
|
+
{% endif %}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
<!-- start custom head snippets, customize with your own _includes/head-custom.html file -->
|
|
2
|
+
|
|
3
|
+
<!-- Setup Google Analytics -->
|
|
4
|
+
{% include head-custom-google-analytics.html %}
|
|
5
|
+
|
|
6
|
+
<!-- You can set your favicon here -->
|
|
7
|
+
<!-- link rel="shortcut icon" type="image/x-icon" href="{{ '/favicon.ico' | relative_url }}" -->
|
|
8
|
+
|
|
9
|
+
<!-- end custom head snippets -->
|
data/_layouts/default.html
CHANGED
|
@@ -4,14 +4,20 @@
|
|
|
4
4
|
<meta charset="UTF-8">
|
|
5
5
|
|
|
6
6
|
{% seo %}
|
|
7
|
+
<link rel="preconnect" href="https://fonts.gstatic.com">
|
|
8
|
+
<link rel="preload" href="https://fonts.googleapis.com/css?family=Open+Sans:400,700&display=swap" as="style" type="text/css" crossorigin>
|
|
7
9
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
8
10
|
<meta name="theme-color" content="#157878">
|
|
11
|
+
<meta name="apple-mobile-web-app-status-bar-style" content="black-translucent">
|
|
9
12
|
<link rel="stylesheet" href="{{ '/assets/css/style.css?v=' | append: site.github.build_revision | relative_url }}">
|
|
13
|
+
{% include head-custom.html %}
|
|
10
14
|
</head>
|
|
11
15
|
<body>
|
|
12
|
-
<
|
|
13
|
-
|
|
14
|
-
|
|
16
|
+
<a id="skip-to-content" href="#content">Skip to the content.</a>
|
|
17
|
+
|
|
18
|
+
<header class="page-header" role="banner">
|
|
19
|
+
<h1 class="project-name">{{ page.title | default: site.title | default: site.github.repository_name }}</h1>
|
|
20
|
+
<h2 class="project-tagline">{{ page.description | default: site.description | default: site.github.project_tagline }}</h2>
|
|
15
21
|
{% if site.github.is_project_page %}
|
|
16
22
|
<a href="{{ site.github.repository_url }}" class="btn">View on GitHub</a>
|
|
17
23
|
{% endif %}
|
|
@@ -19,9 +25,9 @@
|
|
|
19
25
|
<a href="{{ site.github.zip_url }}" class="btn">Download .zip</a>
|
|
20
26
|
<a href="{{ site.github.tar_url }}" class="btn">Download .tar.gz</a>
|
|
21
27
|
{% endif %}
|
|
22
|
-
</
|
|
28
|
+
</header>
|
|
23
29
|
|
|
24
|
-
<
|
|
30
|
+
<main id="content" class="main-content" role="main">
|
|
25
31
|
{{ content }}
|
|
26
32
|
|
|
27
33
|
<footer class="site-footer">
|
|
@@ -30,18 +36,6 @@
|
|
|
30
36
|
{% endif %}
|
|
31
37
|
<span class="site-footer-credits">This page was generated by <a href="https://pages.github.com">GitHub Pages</a>.</span>
|
|
32
38
|
</footer>
|
|
33
|
-
</
|
|
34
|
-
|
|
35
|
-
{% if site.google_analytics %}
|
|
36
|
-
<script>
|
|
37
|
-
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
|
38
|
-
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
|
39
|
-
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
|
40
|
-
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
|
|
41
|
-
|
|
42
|
-
ga('create', '{{ site.google_analytics }}', 'auto');
|
|
43
|
-
ga('send', 'pageview');
|
|
44
|
-
</script>
|
|
45
|
-
{% endif %}
|
|
39
|
+
</main>
|
|
46
40
|
</body>
|
|
47
41
|
</html>
|
data/_sass/cayman.scss
ADDED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
@import "normalize";
|
|
2
2
|
@import "rouge-github";
|
|
3
3
|
@import "variables";
|
|
4
|
-
@import url('https://fonts.googleapis.com/css?family=Open+Sans:400,700');
|
|
4
|
+
@import url('https://fonts.googleapis.com/css?family=Open+Sans:400,700&display=swap');
|
|
5
5
|
|
|
6
6
|
@mixin large {
|
|
7
7
|
@media screen and (min-width: #{$large-breakpoint}) {
|
|
@@ -34,6 +34,24 @@ body {
|
|
|
34
34
|
color: $body-text-color;
|
|
35
35
|
}
|
|
36
36
|
|
|
37
|
+
#skip-to-content {
|
|
38
|
+
height: 1px;
|
|
39
|
+
width: 1px;
|
|
40
|
+
position: absolute;
|
|
41
|
+
overflow: hidden;
|
|
42
|
+
top: -10px;
|
|
43
|
+
|
|
44
|
+
&:focus {
|
|
45
|
+
position: fixed;
|
|
46
|
+
top: 10px;
|
|
47
|
+
left: 10px;
|
|
48
|
+
height: auto;
|
|
49
|
+
width: auto;
|
|
50
|
+
background: invert($body-link-color);
|
|
51
|
+
outline: thick solid invert($body-link-color);
|
|
52
|
+
}
|
|
53
|
+
}
|
|
54
|
+
|
|
37
55
|
a {
|
|
38
56
|
color: $body-link-color;
|
|
39
57
|
text-decoration: none;
|
|
@@ -164,6 +182,20 @@ a {
|
|
|
164
182
|
padding: 2rem 1rem;
|
|
165
183
|
font-size: 1rem;
|
|
166
184
|
}
|
|
185
|
+
|
|
186
|
+
kbd {
|
|
187
|
+
background-color: #fafbfc;
|
|
188
|
+
border: 1px solid #c6cbd1;
|
|
189
|
+
border-bottom-color: #959da5;
|
|
190
|
+
border-radius: 3px;
|
|
191
|
+
box-shadow: inset 0 -1px 0 #959da5;
|
|
192
|
+
color: #444d56;
|
|
193
|
+
display: inline-block;
|
|
194
|
+
font-size: 11px;
|
|
195
|
+
line-height: 10px;
|
|
196
|
+
padding: 3px 5px;
|
|
197
|
+
vertical-align: middle;
|
|
198
|
+
}
|
|
167
199
|
|
|
168
200
|
img {
|
|
169
201
|
max-width: 100%;
|
metadata
CHANGED
|
@@ -1,30 +1,36 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: jekyll-theme-cayman
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.2.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Jason Long
|
|
8
8
|
- GitHub, Inc.
|
|
9
|
-
autorequire:
|
|
9
|
+
autorequire:
|
|
10
10
|
bindir: bin
|
|
11
11
|
cert_chain: []
|
|
12
|
-
date:
|
|
12
|
+
date: 2021-07-29 00:00:00.000000000 Z
|
|
13
13
|
dependencies:
|
|
14
14
|
- !ruby/object:Gem::Dependency
|
|
15
15
|
name: jekyll
|
|
16
16
|
requirement: !ruby/object:Gem::Requirement
|
|
17
17
|
requirements:
|
|
18
|
-
- - "
|
|
18
|
+
- - ">"
|
|
19
19
|
- !ruby/object:Gem::Version
|
|
20
20
|
version: '3.5'
|
|
21
|
+
- - "<"
|
|
22
|
+
- !ruby/object:Gem::Version
|
|
23
|
+
version: '5.0'
|
|
21
24
|
type: :runtime
|
|
22
25
|
prerelease: false
|
|
23
26
|
version_requirements: !ruby/object:Gem::Requirement
|
|
24
27
|
requirements:
|
|
25
|
-
- - "
|
|
28
|
+
- - ">"
|
|
26
29
|
- !ruby/object:Gem::Version
|
|
27
30
|
version: '3.5'
|
|
31
|
+
- - "<"
|
|
32
|
+
- !ruby/object:Gem::Version
|
|
33
|
+
version: '5.0'
|
|
28
34
|
- !ruby/object:Gem::Dependency
|
|
29
35
|
name: jekyll-seo-tag
|
|
30
36
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -54,19 +60,19 @@ dependencies:
|
|
|
54
60
|
- !ruby/object:Gem::Version
|
|
55
61
|
version: '3.0'
|
|
56
62
|
- !ruby/object:Gem::Dependency
|
|
57
|
-
name: rubocop
|
|
63
|
+
name: rubocop-github
|
|
58
64
|
requirement: !ruby/object:Gem::Requirement
|
|
59
65
|
requirements:
|
|
60
66
|
- - "~>"
|
|
61
67
|
- !ruby/object:Gem::Version
|
|
62
|
-
version: '0.
|
|
68
|
+
version: '0.16'
|
|
63
69
|
type: :development
|
|
64
70
|
prerelease: false
|
|
65
71
|
version_requirements: !ruby/object:Gem::Requirement
|
|
66
72
|
requirements:
|
|
67
73
|
- - "~>"
|
|
68
74
|
- !ruby/object:Gem::Version
|
|
69
|
-
version: '0.
|
|
75
|
+
version: '0.16'
|
|
70
76
|
- !ruby/object:Gem::Dependency
|
|
71
77
|
name: w3c_validators
|
|
72
78
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -81,7 +87,7 @@ dependencies:
|
|
|
81
87
|
- - "~>"
|
|
82
88
|
- !ruby/object:Gem::Version
|
|
83
89
|
version: '1.3'
|
|
84
|
-
description:
|
|
90
|
+
description:
|
|
85
91
|
email:
|
|
86
92
|
- opensource+jekyll-theme-cayman@github.com
|
|
87
93
|
executables: []
|
|
@@ -90,7 +96,10 @@ extra_rdoc_files: []
|
|
|
90
96
|
files:
|
|
91
97
|
- LICENSE
|
|
92
98
|
- README.md
|
|
99
|
+
- _includes/head-custom-google-analytics.html
|
|
100
|
+
- _includes/head-custom.html
|
|
93
101
|
- _layouts/default.html
|
|
102
|
+
- _sass/cayman.scss
|
|
94
103
|
- _sass/jekyll-theme-cayman.scss
|
|
95
104
|
- _sass/normalize.scss
|
|
96
105
|
- _sass/rouge-github.scss
|
|
@@ -100,7 +109,7 @@ homepage: https://github.com/pages-themes/cayman
|
|
|
100
109
|
licenses:
|
|
101
110
|
- CC0-1.0
|
|
102
111
|
metadata: {}
|
|
103
|
-
post_install_message:
|
|
112
|
+
post_install_message:
|
|
104
113
|
rdoc_options: []
|
|
105
114
|
require_paths:
|
|
106
115
|
- lib
|
|
@@ -108,16 +117,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
|
108
117
|
requirements:
|
|
109
118
|
- - ">="
|
|
110
119
|
- !ruby/object:Gem::Version
|
|
111
|
-
version:
|
|
120
|
+
version: 2.4.0
|
|
112
121
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
|
113
122
|
requirements:
|
|
114
123
|
- - ">="
|
|
115
124
|
- !ruby/object:Gem::Version
|
|
116
125
|
version: '0'
|
|
117
126
|
requirements: []
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
signing_key:
|
|
127
|
+
rubygems_version: 3.2.15
|
|
128
|
+
signing_key:
|
|
121
129
|
specification_version: 4
|
|
122
130
|
summary: Cayman is a Jekyll theme for GitHub Pages
|
|
123
131
|
test_files: []
|