jekyll-theme-tactile 0.0.3 → 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
- SHA1:
3
- metadata.gz: 0bab7dba714a1c09aeba8f86d61177faf07e71a7
4
- data.tar.gz: 99abdfd2e464aecb5ea11fe7a9bfe2e8ce205e5b
2
+ SHA256:
3
+ metadata.gz: 38e590047faede61540b592fa65724545a90a0424d02514aed6d9d55c2ee5f16
4
+ data.tar.gz: 7c9aa1feb4fe8f9d66d01bb474fa20eb682bf92f1b0807c92c4ac5e90fd80c95
5
5
  SHA512:
6
- metadata.gz: 6e3cffd0fa1f517c271f657bccc2ef3777e7443c68cdfdb7ddf1baeabd86c63c1d39df547bfee3210ee1553eb2dd7eefea74adf8efbebb0a8209c3a5090aa143
7
- data.tar.gz: a207d59461be2aade0d83343692a9862432e18a4080f1eab0462c1591ff377a318e29bdf2b9b8178e7873b53b834817b6591a1e6e690ce796ebb0e87d5ed511e
6
+ metadata.gz: 56b322ab641491ade5aab4bac93430f066dd4dddc3b52e44e8c538cd18b6605d73de48403b2623829a296f7989ae1aecf71bcd21fe7fac69824aec3366192f41
7
+ data.tar.gz: 2b009b32c72cdc83a1f6c63c31fbd1cdcf34945841f10dcfe9d40b494aa2cc65ac710d041e3f494da350df375bfcc0bd51fe99baf830756e55ca14a0facaca66
data/README.md CHANGED
@@ -1,10 +1,10 @@
1
1
  # The Tactile theme
2
2
 
3
- [![Build Status](https://travis-ci.org/pages-themes/jekyll-theme-tactile.svg?branch=master)](https://travis-ci.org/pages-themes/jekyll-theme-tactile) [![Gem Version](https://badge.fury.io/rb/jekyll-theme-tactile.svg)](https://badge.fury.io/rb/jekyll-theme-tactile)
3
+ [![.github/workflows/ci.yaml](https://github.com/pages-themes/tactile/actions/workflows/ci.yaml/badge.svg)](https://github.com/pages-themes/tactile/actions/workflows/ci.yaml) [![Gem Version](https://badge.fury.io/rb/jekyll-theme-tactile.svg)](https://badge.fury.io/rb/jekyll-theme-tactile)
4
4
 
5
5
  *Tactile is a Jekyll theme for GitHub Pages. You can [preview the theme to see what it looks like](http://pages-themes.github.io/tactile), or even [use it today](#usage).*
6
6
 
7
- ![Thumbnail of tactile](thumbnail.png)
7
+ ![Thumbnail of Tactile](thumbnail.png)
8
8
 
9
9
  ## Usage
10
10
 
@@ -13,7 +13,9 @@ To use the Tactile theme:
13
13
  1. Add the following to your site's `_config.yml`:
14
14
 
15
15
  ```yml
16
- theme: jekyll-theme-tactile
16
+ remote_theme: pages-themes/tactile@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 Tactile 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,7 +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
- 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]
42
42
  google_analytics: [Your Google Analytics tracking ID]
43
43
  ```
44
44
 
@@ -46,7 +46,7 @@ google_analytics: [Your Google Analytics tracking ID]
46
46
 
47
47
  If you'd like to add your own custom styles:
48
48
 
49
- 1. Create a file called `/assets/css/style.css` in your site
49
+ 1. Create a file called `/assets/css/style.scss` in your site
50
50
  2. Add the following content to the top of the file, exactly as shown:
51
51
  ```scss
52
52
  ---
@@ -56,18 +56,42 @@ If you'd like to add your own custom styles:
56
56
  ```
57
57
  3. Add any custom CSS (or Sass, including imports) you'd like immediately after the `@import` line
58
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
+
59
61
  ### Layouts
60
62
 
61
63
  If you'd like to change the theme's HTML layout:
62
64
 
63
- 1. [Copy the original template](https://github.com/pages-themes/tactile/blob/master/_layouts/default.html) from the theme's repository<br />(*Pro-tip: click "raw" to make copying easier*)
64
- 2. Create a file called `/_layouts/default.html` in your site
65
- 3. Paste the default layout content copied in the first step
66
- 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/tactile/tree/master/_includes) provide a starting point and are included by the [original layout template](https://github.com/pages-themes/tactile/blob/master/_layouts/default.html).
66
+ 2. For more extensive changes, [copy the original template](https://github.com/pages-themes/tactile/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/tactile/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/).
67
91
 
68
92
  ## Roadmap
69
93
 
70
- See the [open issues](https://github.com/pagse-themes/tactile/issues) for a list of proposed features (and known issues).
94
+ See the [open issues](https://github.com/pages-themes/tactile/issues) for a list of proposed features (and known issues).
71
95
 
72
96
  ## Project philosophy
73
97
 
@@ -75,7 +99,7 @@ The Tactile theme is intended to make it quick and easy for GitHub Pages users t
75
99
 
76
100
  ## Contributing
77
101
 
78
- Interested in contributing to Tactile? We'd love your help. Tactile 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.
102
+ Interested in contributing to Tactile? We'd love your help. Tactile 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.
79
103
 
80
104
  ### Previewing the theme locally
81
105
 
@@ -89,4 +113,4 @@ If you'd like to preview the theme locally (for example, in the process of propo
89
113
 
90
114
  ### Running tests
91
115
 
92
- 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 -->
@@ -1,15 +1,17 @@
1
1
  <!DOCTYPE html>
2
- <html>
2
+ <html lang="{{ site.lang | default: "en-US" }}">
3
3
  <head>
4
4
  <meta charset='utf-8'>
5
- <meta http-equiv="X-UA-Compatible" content="chrome=1">
6
- <link href='https://fonts.googleapis.com/css?family=Chivo:900' rel='stylesheet' type='text/css'>
5
+ <meta name="viewport" content="width=device-width, initial-scale=1">
6
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
7
7
  <link rel="stylesheet" href="{{ '/assets/css/style.css?v=' | append: site.github.build_revision | relative_url }}">
8
8
  <link rel="stylesheet" type="text/css" href="{{ '/assets/css/print.css' | relative_url }}" media="print">
9
9
  <!--[if lt IE 9]>
10
10
  <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
11
11
  <![endif]-->
12
- <title>{{ site.title | default: site.github.repository_name }} by {{ site.github.owner_name }}</title>
12
+
13
+ {% seo %}
14
+ {% include head-custom.html %}
13
15
  </head>
14
16
 
15
17
  <body>
@@ -17,20 +19,23 @@
17
19
  <div class="inner">
18
20
 
19
21
  <header>
20
- <h1>{{ site.title | default: site.github.repository_name }}</h1>
21
- <h2>{{ site.description | default: site.github.project_tagline }}</h2>
22
+ <h1>{{ page.title | default: site.title | default: site.github.repository_name }}</h1>
23
+ <h2>{{ page.description | default: site.description | default: site.github.project_tagline }}</h2>
22
24
  </header>
23
-
24
25
  <section id="downloads" class="clearfix">
25
26
  {% if site.show_downloads %}
26
27
  <a href="{{ site.github.zip_url }}" id="download-zip" class="button"><span>Download .zip</span></a>
27
28
  <a href="{{ site.github.tar_url }}" id="download-tar-gz" class="button"><span>Download .tar.gz</span></a>
28
29
  {% endif %}
30
+ {% if site.github.public %}
31
+ {% if site.github.is_project_page %}
29
32
  <a href="{{ site.github.repository_url }}" id="view-on-github" class="button"><span>View on GitHub</span></a>
33
+ {% else %}
34
+ <a href="{{ site.github.owner_url }}" id="view-on-github" class="button"><span>View on GitHub</span></a>
35
+ {% endif %}
36
+ {% endif %}
30
37
  </section>
31
-
32
38
  <hr>
33
-
34
39
  <section id="main_content">
35
40
  {{ content }}
36
41
  </section>
@@ -44,18 +49,5 @@
44
49
 
45
50
  </div>
46
51
  </div>
47
-
48
- {% if site.google_analytics %}
49
- <script type="text/javascript">
50
- var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
51
- document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
52
- </script>
53
- <script type="text/javascript">
54
- try {
55
- var pageTracker = _gat._getTracker("{{ site.google_analytics }}");
56
- pageTracker._trackPageview();
57
- } catch(err) {}
58
- </script>
59
- {% endif %}
60
52
  </body>
61
53
  </html>
@@ -1,4 +1,5 @@
1
1
  @import "rouge-base16-dark";
2
+ @import url('https://fonts.googleapis.com/css?family=Chivo:900');
2
3
 
3
4
  /* http://meyerweb.com/eric/tools/css/reset/
4
5
  v2.0 | 20110126
@@ -120,7 +121,7 @@ a.button {
120
121
  background: -webkit-linear-gradient(top, #fdfdfd 0%,#f2f2f2 100%); /* Chrome10+,Safari5.1+ */
121
122
  background: -o-linear-gradient(top, #fdfdfd 0%,#f2f2f2 100%); /* Opera 11.10+ */
122
123
  background: -ms-linear-gradient(top, #fdfdfd 0%,#f2f2f2 100%); /* IE10+ */
123
- background: linear-gradient(top, #fdfdfd 0%,#f2f2f2 100%); /* W3C */
124
+ background: linear-gradient(to top, #fdfdfd 0%,#f2f2f2 100%); /* W3C */
124
125
  filter: progid:DXImageTransform.Microsoft.gradient( startColorstr='#fdfdfd', endColorstr='#f2f2f2',GradientType=0 ); /* IE6-9 */
125
126
  border-top: solid 1px #cbcbcb;
126
127
  border-right: solid 1px #b7b7b7;
@@ -140,7 +141,7 @@ a.button:hover {
140
141
  background: -webkit-linear-gradient(top, #fdfdfd 0%,#f6f6f6 100%); /* Chrome10+,Safari5.1+ */
141
142
  background: -o-linear-gradient(top, #fdfdfd 0%,#f6f6f6 100%); /* Opera 11.10+ */
142
143
  background: -ms-linear-gradient(top, #fdfdfd 0%,#f6f6f6 100%); /* IE10+ */
143
- background: linear-gradient(top, #fdfdfd 0%,#f6f6f6, 100%); /* W3C */
144
+ background: linear-gradient(to top, #fdfdfd 0%,#f6f6f6, 100%); /* W3C */
144
145
  filter: progid:DXImageTransform.Microsoft.gradient( startColorstr='#fdfdfd', endColorstr='#f6f6f6',GradientType=0 ); /* IE6-9 */
145
146
  border-top: solid 1px #b7b7b7;
146
147
  border-right: solid 1px #b3b3b3;
@@ -169,7 +170,7 @@ a.button span {
169
170
 
170
171
  code, pre {
171
172
  margin-bottom: 30px;
172
- font-family: Monaco, "Bitstream Vera Sans Mono", "Lucida Console", Terminal;
173
+ font-family: Monaco, "Bitstream Vera Sans Mono", "Lucida Console", Terminal, monospace;
173
174
  font-size: 14px;
174
175
  color: #222;
175
176
  }
@@ -366,6 +367,13 @@ footer a:hover {
366
367
  width: 94%;
367
368
  margin: 0 auto;
368
369
  }
370
+ ul li {
371
+ margin-left: 10px;
372
+ padding-left: 10px;
373
+ }
374
+ ol li {
375
+ margin-left: 10px;
376
+ }
369
377
  }
370
378
 
371
379
  /* Mobile Landscape Size to Tablet Portrait (devices and browsers) */
@@ -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-tactile";
metadata CHANGED
@@ -1,31 +1,93 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: jekyll-theme-tactile
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.0.3
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: 2016-12-14 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
+ requirement: !ruby/object:Gem::Requirement
17
+ requirements:
18
+ - - ">"
19
+ - !ruby/object:Gem::Version
20
+ version: '3.5'
21
+ - - "<"
22
+ - !ruby/object:Gem::Version
23
+ version: '5.0'
24
+ type: :runtime
25
+ prerelease: false
26
+ version_requirements: !ruby/object:Gem::Requirement
27
+ requirements:
28
+ - - ">"
29
+ - !ruby/object:Gem::Version
30
+ version: '3.5'
31
+ - - "<"
32
+ - !ruby/object:Gem::Version
33
+ version: '5.0'
34
+ - !ruby/object:Gem::Dependency
35
+ name: jekyll-seo-tag
16
36
  requirement: !ruby/object:Gem::Requirement
17
37
  requirements:
18
38
  - - "~>"
19
39
  - !ruby/object:Gem::Version
20
- version: '3.3'
40
+ version: '2.0'
21
41
  type: :runtime
22
42
  prerelease: false
23
43
  version_requirements: !ruby/object:Gem::Requirement
24
44
  requirements:
25
45
  - - "~>"
26
46
  - !ruby/object:Gem::Version
27
- version: '3.3'
28
- description:
47
+ version: '2.0'
48
+ - !ruby/object:Gem::Dependency
49
+ name: html-proofer
50
+ requirement: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '3.0'
55
+ type: :development
56
+ prerelease: false
57
+ version_requirements: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '3.0'
62
+ - !ruby/object:Gem::Dependency
63
+ name: rubocop-github
64
+ requirement: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '0.16'
69
+ type: :development
70
+ prerelease: false
71
+ version_requirements: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - "~>"
74
+ - !ruby/object:Gem::Version
75
+ version: '0.16'
76
+ - !ruby/object:Gem::Dependency
77
+ name: w3c_validators
78
+ requirement: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - "~>"
81
+ - !ruby/object:Gem::Version
82
+ version: '1.3'
83
+ type: :development
84
+ prerelease: false
85
+ version_requirements: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - "~>"
88
+ - !ruby/object:Gem::Version
89
+ version: '1.3'
90
+ description:
29
91
  email:
30
92
  - opensource+jekyll-theme-tactile@github.com
31
93
  executables: []
@@ -34,9 +96,12 @@ extra_rdoc_files: []
34
96
  files:
35
97
  - LICENSE
36
98
  - README.md
99
+ - _includes/head-custom-google-analytics.html
100
+ - _includes/head-custom.html
37
101
  - _layouts/default.html
38
102
  - _sass/jekyll-theme-tactile.scss
39
103
  - _sass/rouge-base16-dark.scss
104
+ - _sass/tactile.scss
40
105
  - assets/css/print.css
41
106
  - assets/css/style.scss
42
107
  - assets/images/body-bg.png
@@ -49,7 +114,7 @@ homepage: https://github.com/pages-themes/tactile
49
114
  licenses:
50
115
  - CC0-1.0
51
116
  metadata: {}
52
- post_install_message:
117
+ post_install_message:
53
118
  rdoc_options: []
54
119
  require_paths:
55
120
  - lib
@@ -64,9 +129,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
64
129
  - !ruby/object:Gem::Version
65
130
  version: '0'
66
131
  requirements: []
67
- rubyforge_project:
68
- rubygems_version: 2.5.2
69
- signing_key:
132
+ rubygems_version: 3.2.15
133
+ signing_key:
70
134
  specification_version: 4
71
135
  summary: Tactile is a Jekyll theme for GitHub Pages
72
136
  test_files: []