jekyll-theme-minimal 0.1.1 → 0.2.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: f94e40aebad6ea69f1136be9d6c7613f433768a09528ab36ce6fb2bcecf57a74
4
- data.tar.gz: 872d5574b25d5bf6163871bb3dff88bd5b59e7515d0c477c10fca9f16bb8f4d4
3
+ metadata.gz: 6b010a75106c16955407bcd7a2fd1f416728cfa6c6fcee2274521350dbcf68d0
4
+ data.tar.gz: cda02163a7e6a0784e9a85542211ee41bd05d9a55e527d2b38c1032e26caa5f7
5
5
  SHA512:
6
- metadata.gz: 84493d6a237e70f0558f41c0c98305d6a55668d872bad6f635400fdd935c85cbe7f8bd9947d1685415509058332134352a47c40a6ebb8df0c3004ac7418fd408
7
- data.tar.gz: fe277d404f48a6e5dcfe1926f45a73dcc062cb9cefa656352a3143dffc6d94350f2e9d01872d0fcd09fb5fff5d694cac9e7ce3bd32e1602c295a128dc09d7244
6
+ metadata.gz: a35b0518c06091e3d7252be1f1e02460366e5469a8fd2fa1f3f515c126c273d0930a0e9ef5ec2fbee3d334aa458840fa7d8e9ded27fced80568e6a344650b025
7
+ data.tar.gz: 5d9b0796c32901d6028c4fdada2b2507f0f2ed1b7f72f518fd5e6b228ae38e20d3549a213a13828a91c0de33827b11395b603df948fd78a3468c41ced30d48c5
data/README.md CHANGED
@@ -1,10 +1,10 @@
1
1
  # The Minimal theme
2
2
 
3
- [![Build Status](https://travis-ci.org/pages-themes/minimal.svg?branch=master)](https://travis-ci.org/pages-themes/minimal) [![Gem Version](https://badge.fury.io/rb/jekyll-theme-minimal.svg)](https://badge.fury.io/rb/jekyll-theme-minimal)
3
+ [![.github/workflows/ci.yaml](https://github.com/pages-themes/minimal/actions/workflows/ci.yaml/badge.svg)](https://github.com/pages-themes/minimal/actions/workflows/ci.yaml) [![Gem Version](https://badge.fury.io/rb/jekyll-theme-minimal.svg)](https://badge.fury.io/rb/jekyll-theme-minimal)
4
4
 
5
5
  *Minimal is a Jekyll theme for GitHub Pages. You can [preview the theme to see what it looks like](http://pages-themes.github.io/minimal), or even [use it today](#usage).*
6
6
 
7
- ![Thumbnail of minimal](thumbnail.png)
7
+ ![Thumbnail of Minimal](thumbnail.png)
8
8
 
9
9
  ## Usage
10
10
 
@@ -13,7 +13,9 @@ To use the Minimal theme:
13
13
  1. Add the following to your site's `_config.yml`:
14
14
 
15
15
  ```yml
16
- theme: jekyll-theme-minimal
16
+ remote_theme: pages-themes/minimal@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`:
@@ -22,8 +24,6 @@ To use the Minimal theme:
22
24
  gem "github-pages", group: :jekyll_plugins
23
25
  ```
24
26
 
25
-
26
-
27
27
  ## Customizing
28
28
 
29
29
  ### Configuration variables
@@ -38,8 +38,7 @@ description: [A short description of your site's purpose]
38
38
  Additionally, you may choose to set the following optional variables:
39
39
 
40
40
  ```yml
41
- logo: [Location of the logo]
42
- 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]
43
42
  google_analytics: [Your Google Analytics tracking ID]
44
43
  ```
45
44
 
@@ -57,14 +56,38 @@ If you'd like to add your own custom styles:
57
56
  ```
58
57
  3. Add any custom CSS (or Sass, including imports) you'd like immediately after the `@import` line
59
58
 
59
+ *Note: If you'd like to change the theme's Sass variables, you must set new values before the `@import` line in your stylesheet.*
60
+
60
61
  ### Layouts
61
62
 
62
63
  If you'd like to change the theme's HTML layout:
63
64
 
64
- 1. [Copy the original template](https://github.com/pages-themes/minimal/blob/master/_layouts/default.html) from the theme's repository<br />(*Pro-tip: click "raw" to make copying easier*)
65
- 2. Create a file called `/_layouts/default.html` in your site
66
- 3. Paste the default layout content copied in the first step
67
- 4. Customize the layout as you'd like
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/minimal/tree/master/_includes) provide a starting point and are included by the [original layout template](https://github.com/pages-themes/minimal/blob/master/_layouts/default.html).
66
+ 2. For more extensive changes, [copy the original template](https://github.com/pages-themes/minimal/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.
74
+
75
+ ### Overriding GitHub-generated URLs
76
+
77
+ 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:
78
+
79
+ 1. Look at [the template source](https://github.com/pages-themes/minimal/blob/master/_layouts/default.html) to determine the name of the variable. It will be in the form of `{{ site.github.zip_url }}`.
80
+ 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:
81
+ ```yml
82
+ github:
83
+ zip_url: http://example.com/download.zip
84
+ another_url: another value
85
+ ```
86
+ 3. When your site is built, Jekyll will use the URL you specified, rather than the default one provided by GitHub.
87
+
88
+ *Note: You must remove the `site.` prefix, and each variable name (after the `github.`) should be indent with two space below `github:`.*
89
+
90
+ For more information, see [the Jekyll variables documentation](https://jekyllrb.com/docs/variables/).
68
91
 
69
92
  ## Roadmap
70
93
 
@@ -90,4 +113,4 @@ If you'd like to preview the theme locally (for example, in the process of propo
90
113
 
91
114
  ### Running tests
92
115
 
93
- 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` one before the test script will work.
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 -->
@@ -8,14 +8,15 @@
8
8
  {% seo %}
9
9
  <link rel="stylesheet" href="{{ "/assets/css/style.css?v=" | append: site.github.build_revision | relative_url }}">
10
10
  <!--[if lt IE 9]>
11
- <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv.min.js"></script>
11
+ <script src="https://cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv.min.js"></script>
12
12
  <![endif]-->
13
+ {% include head-custom.html %}
13
14
  </head>
14
15
  <body>
15
16
  <div class="wrapper">
16
17
  <header>
17
18
  <h1><a href="{{ "/" | absolute_url }}">{{ site.title | default: site.github.repository_name }}</a></h1>
18
-
19
+
19
20
  {% if site.logo %}
20
21
  <img src="{{site.logo | relative_url}}" alt="Logo" />
21
22
  {% endif %}
@@ -31,7 +32,7 @@
31
32
  {% endif %}
32
33
 
33
34
  {% if site.show_downloads %}
34
- <ul>
35
+ <ul class="downloads">
35
36
  <li><a href="{{ site.github.zip_url }}">Download <strong>ZIP File</strong></a></li>
36
37
  <li><a href="{{ site.github.tar_url }}">Download <strong>TAR Ball</strong></a></li>
37
38
  <li><a href="{{ site.github.repository_url }}">View On <strong>GitHub</strong></a></li>
@@ -51,15 +52,5 @@
51
52
  </footer>
52
53
  </div>
53
54
  <script src="{{ "/assets/js/scale.fix.js" | relative_url }}"></script>
54
- {% if site.google_analytics %}
55
- <script>
56
- (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
57
- (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
58
- m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
59
- })(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
60
- ga('create', '{{ site.google_analytics }}', 'auto');
61
- ga('send', 'pageview');
62
- </script>
63
- {% endif %}
64
55
  </body>
65
56
  </html>
@@ -104,6 +104,20 @@ img {
104
104
  max-width:100%;
105
105
  }
106
106
 
107
+ kbd {
108
+ background-color: #fafbfc;
109
+ border: 1px solid #c6cbd1;
110
+ border-bottom-color: #959da5;
111
+ border-radius: 3px;
112
+ box-shadow: inset 0 -1px 0 #959da5;
113
+ color: #444d56;
114
+ display: inline-block;
115
+ font-size: 11px;
116
+ line-height: 10px;
117
+ padding: 3px 5px;
118
+ vertical-align: middle;
119
+ }
120
+
107
121
  header {
108
122
  width:270px;
109
123
  float:left;
@@ -111,7 +125,7 @@ header {
111
125
  -webkit-font-smoothing:subpixel-antialiased;
112
126
  }
113
127
 
114
- header ul {
128
+ ul.downloads {
115
129
  list-style:none;
116
130
  height:40px;
117
131
  padding:0;
@@ -121,22 +135,22 @@ header ul {
121
135
  width:270px;
122
136
  }
123
137
 
124
- header li {
138
+ .downloads li {
125
139
  width:89px;
126
140
  float:left;
127
141
  border-right:1px solid #e0e0e0;
128
142
  height:40px;
129
143
  }
130
144
 
131
- header li:first-child a {
145
+ .downloads li:first-child a {
132
146
  border-radius:5px 0 0 5px;
133
147
  }
134
148
 
135
- header li:last-child a {
149
+ .downloads li:last-child a {
136
150
  border-radius:0 5px 5px 0;
137
151
  }
138
152
 
139
- header ul a {
153
+ .downloads a {
140
154
  line-height:1;
141
155
  font-size:11px;
142
156
  color:#676767;
@@ -146,12 +160,12 @@ header ul a {
146
160
  height:34px;
147
161
  }
148
162
 
149
- header ul a:hover, header ul a:focus {
163
+ .downloads a:hover, .downloads a:focus {
150
164
  color:#675C5C;
151
165
  font-weight:bold;
152
166
  }
153
167
 
154
- header ul a:active {
168
+ .downloads ul a:active {
155
169
  background-color:#f0f0f0;
156
170
  }
157
171
 
@@ -160,12 +174,12 @@ strong {
160
174
  font-weight:700;
161
175
  }
162
176
 
163
- header ul li + li + li {
177
+ .downloads li + li + li {
164
178
  border-right:none;
165
179
  width:89px;
166
180
  }
167
181
 
168
- header ul a strong {
182
+ .downloads a strong {
169
183
  font-size:14px;
170
184
  display:block;
171
185
  color:#222;
@@ -254,11 +268,11 @@ footer {
254
268
  padding:15px;
255
269
  }
256
270
 
257
- header ul {
271
+ .downloads {
258
272
  width:99%;
259
273
  }
260
274
 
261
- header li, header ul li + li + li {
275
+ .downloads li, .downloads li + li + li {
262
276
  width:33%;
263
277
  }
264
278
  }
@@ -0,0 +1,4 @@
1
+ // Placeholder file. If your site uses
2
+ // @import "{{ site.theme }}";
3
+ // Then using this theme with jekyll-remote-theme will work fine.
4
+ @import "jekyll-theme-minimal";
metadata CHANGED
@@ -1,30 +1,36 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: jekyll-theme-minimal
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.1
4
+ version: 0.2.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Steve Smith
8
8
  - GitHub, Inc.
9
- autorequire:
9
+ autorequire:
10
10
  bindir: bin
11
11
  cert_chain: []
12
- date: 2018-04-11 00:00:00.000000000 Z
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.50'
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.50'
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-minimal@github.com
87
93
  executables: []
@@ -90,10 +96,13 @@ 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
94
102
  - _layouts/post.html
95
103
  - _sass/fonts.scss
96
104
  - _sass/jekyll-theme-minimal.scss
105
+ - _sass/minimal.scss
97
106
  - _sass/rouge-github.scss
98
107
  - assets/css/style.scss
99
108
  - assets/fonts/Noto-Sans-700/Noto-Sans-700.eot
@@ -122,7 +131,7 @@ homepage: https://github.com/pages-themes/minimal
122
131
  licenses:
123
132
  - CC0-1.0
124
133
  metadata: {}
125
- post_install_message:
134
+ post_install_message:
126
135
  rdoc_options: []
127
136
  require_paths:
128
137
  - lib
@@ -130,16 +139,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
130
139
  requirements:
131
140
  - - ">="
132
141
  - !ruby/object:Gem::Version
133
- version: '0'
142
+ version: 2.4.0
134
143
  required_rubygems_version: !ruby/object:Gem::Requirement
135
144
  requirements:
136
145
  - - ">="
137
146
  - !ruby/object:Gem::Version
138
147
  version: '0'
139
148
  requirements: []
140
- rubyforge_project:
141
- rubygems_version: 2.7.6
142
- signing_key:
149
+ rubygems_version: 3.2.15
150
+ signing_key:
143
151
  specification_version: 4
144
152
  summary: Minimal is a Jekyll theme for GitHub Pages
145
153
  test_files: []