jekyll-theme-cayman 0.1.0 → 0.1.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (5) hide show
  1. checksums.yaml +5 -5
  2. data/README.md +17 -10
  3. data/_layouts/default.html +1 -3
  4. data/_sass/jekyll-theme-cayman.scss +1 -0
  5. metadata +45 -3
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA1:
3
- metadata.gz: c5edd806137fedb1290e73855d2f592d349c6017
4
- data.tar.gz: 6823ea4bfaca38f084b07971923cb728a28ffe43
2
+ SHA256:
3
+ metadata.gz: 95e75e1f9994a4e573da35d4e51592f80e493a5d6f4b270e54c37d02b47aac75
4
+ data.tar.gz: 28c0a016f7e2a7d56f8d3e135ad1c176dbcb0c81d6a441be57626966717539e7
5
5
  SHA512:
6
- metadata.gz: cc56702302d37401c88a75c01e538759a32c6f72d7fc2b0b14f9de256a7eff4a2a712339cc67677ae49a25d241a0c4d23bc141be337852c17c2f048154f92068
7
- data.tar.gz: eb7e8ba9c5268535e25bbe7c6c1b12df58b1fa3d2be3e0a5e9ac1ae64605f627d0c1febd73e64957115da670bbf61438a98eec10d044ceb454c7441d11bd4e25
6
+ metadata.gz: cc314a2c9a00cf6996a6d8de79195ef4d1f784dc14cdf2a42e3acf1bf5ce21361b5e4e12a61edea046ba4f3ca2c0e89166f5540fdd6f9aca1da35ccca912961b
7
+ data.tar.gz: 20684af1a638b4204a87cbbd1b273be704c0dc50d7ae27fdf1247a5493536b8ec47b1524dbb7bda6083b0831784bccb2b448a182fafb6a850e0360b72a9ad6bb
data/README.md CHANGED
@@ -4,7 +4,7 @@
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
 
7
- ![Thumbnail of cayman](thumbnail.png)
7
+ ![Thumbnail of Cayman](thumbnail.png)
8
8
 
9
9
  ## Usage
10
10
 
@@ -22,8 +22,6 @@ To use the Cayman theme:
22
22
  gem "github-pages", group: :jekyll_plugins
23
23
  ```
24
24
 
25
-
26
-
27
25
  ## Customizing
28
26
 
29
27
  ### Configuration variables
@@ -56,6 +54,8 @@ If you'd like to add your own custom styles:
56
54
  ```
57
55
  3. Add any custom CSS (or Sass, including imports) you'd like immediately after the `@import` line
58
56
 
57
+ *Note: If you'd like to change the theme's Sass variables, you must set new values before the `@import` line in your stylesheet.*
58
+
59
59
  ### Layouts
60
60
 
61
61
  If you'd like to change the theme's HTML layout:
@@ -65,15 +65,22 @@ If you'd like to change the theme's HTML layout:
65
65
  3. Paste the default layout content copied in the first step
66
66
  4. Customize the layout as you'd like
67
67
 
68
- ### Sass variables
68
+ ### Overriding GitHub-generated URLs
69
69
 
70
- If you'd like to change the theme's [Sass variables](https://github.com/pages-themes/cayman/blob/master/_sass/variables.scss), set new values before the `@import` line in your stylesheet:
70
+ Templates often rely on URLs supplied by GitHub such as links to your repository or links to download your project. If you'd like to override one or more default URLs:
71
71
 
72
- ```scss
73
- $section-headings-color: #0086b3;
72
+ 1. Look at [the template source](https://github.com/pages-themes/cayman/blob/master/_layouts/default.html) to determine the name of the variable. It will be in the form of `{{ site.github.zip_url }}`.
73
+ 2. Specify the URL that you'd like the template to use in your site's `_config.yml`. For example, if the variable was `site.github.url`, you'd add the following:
74
+ ```yml
75
+ github:
76
+ zip_url: http://example.com/download.zip
77
+ another_url: another value
78
+ ```
79
+ 3. When your site is built, Jekyll will use the URL you specified, rather than the default one provided by GitHub.
74
80
 
75
- @import "{{ site.theme }}";
76
- ```
81
+ *Note: You must remove the `site.` prefix, and each variable name (after the `github.`) should be indent with two space below `github:`.*
82
+
83
+ For more information, see [the Jekyll variables documentation](https://jekyllrb.com/docs/variables/).
77
84
 
78
85
  ## Roadmap
79
86
 
@@ -85,7 +92,7 @@ The Cayman theme is intended to make it quick and easy for GitHub Pages users to
85
92
 
86
93
  ## Contributing
87
94
 
88
- Interested in contributing to Cayman? We'd love your help. Cayman is an open source project, built one contribution at a time by users like you. See [the CONTRIBUTING file](CONTRIBUTING.md) for instructions on how to contribute.
95
+ Interested in contributing to Cayman? We'd love your help. Cayman is an open source project, built one contribution at a time by users like you. See [the CONTRIBUTING file](docs/CONTRIBUTING.md) for instructions on how to contribute.
89
96
 
90
97
  ### Previewing the theme locally
91
98
 
data/_layouts/default.html CHANGED
@@ -4,10 +4,8 @@
4
4
  <meta charset="UTF-8">
5
5
 
6
6
  {% seo %}
7
- <meta name="description" content="{{ page.description | default: site.description | default: site.github.project_tagline }}"/>
8
7
  <meta name="viewport" content="width=device-width, initial-scale=1">
9
8
  <meta name="theme-color" content="#157878">
10
- <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700' rel='stylesheet' type='text/css'>
11
9
  <link rel="stylesheet" href="{{ '/assets/css/style.css?v=' | append: site.github.build_revision | relative_url }}">
12
10
  </head>
13
11
  <body>
@@ -35,7 +33,7 @@
35
33
  </section>
36
34
 
37
35
  {% if site.google_analytics %}
38
- <script type="text/javascript">
36
+ <script>
39
37
  (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
40
38
  (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
41
39
  m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
data/_sass/jekyll-theme-cayman.scss CHANGED
@@ -1,6 +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
5
 
5
6
  @mixin large {
6
7
  @media screen and (min-width: #{$large-breakpoint}) {
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: jekyll-theme-cayman
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.0
4
+ version: 0.1.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Jason Long
@@ -9,7 +9,7 @@ authors:
9
9
  autorequire:
10
10
  bindir: bin
11
11
  cert_chain: []
12
- date: 2017-08-14 00:00:00.000000000 Z
12
+ date: 2018-04-11 00:00:00.000000000 Z
13
13
  dependencies:
14
14
  - !ruby/object:Gem::Dependency
15
15
  name: jekyll
@@ -39,6 +39,48 @@ dependencies:
39
39
  - - "~>"
40
40
  - !ruby/object:Gem::Version
41
41
  version: '2.0'
42
+ - !ruby/object:Gem::Dependency
43
+ name: html-proofer
44
+ requirement: !ruby/object:Gem::Requirement
45
+ requirements:
46
+ - - "~>"
47
+ - !ruby/object:Gem::Version
48
+ version: '3.0'
49
+ type: :development
50
+ prerelease: false
51
+ version_requirements: !ruby/object:Gem::Requirement
52
+ requirements:
53
+ - - "~>"
54
+ - !ruby/object:Gem::Version
55
+ version: '3.0'
56
+ - !ruby/object:Gem::Dependency
57
+ name: rubocop
58
+ requirement: !ruby/object:Gem::Requirement
59
+ requirements:
60
+ - - "~>"
61
+ - !ruby/object:Gem::Version
62
+ version: '0.50'
63
+ type: :development
64
+ prerelease: false
65
+ version_requirements: !ruby/object:Gem::Requirement
66
+ requirements:
67
+ - - "~>"
68
+ - !ruby/object:Gem::Version
69
+ version: '0.50'
70
+ - !ruby/object:Gem::Dependency
71
+ name: w3c_validators
72
+ requirement: !ruby/object:Gem::Requirement
73
+ requirements:
74
+ - - "~>"
75
+ - !ruby/object:Gem::Version
76
+ version: '1.3'
77
+ type: :development
78
+ prerelease: false
79
+ version_requirements: !ruby/object:Gem::Requirement
80
+ requirements:
81
+ - - "~>"
82
+ - !ruby/object:Gem::Version
83
+ version: '1.3'
42
84
  description:
43
85
  email:
44
86
  - opensource+jekyll-theme-cayman@github.com
@@ -74,7 +116,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
74
116
  version: '0'
75
117
  requirements: []
76
118
  rubyforge_project:
77
- rubygems_version: 2.6.11
119
+ rubygems_version: 2.7.6
78
120
  signing_key:
79
121
  specification_version: 4
80
122
  summary: Cayman is a Jekyll theme for GitHub Pages