jekyll-theme-time-machine 0.1.0 → 0.1.1

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.
Files changed (4) hide show
  1. checksums.yaml +5 -5
  2. data/README.md +21 -4
  3. data/_layouts/default.html +6 -8
  4. metadata +45 -3
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA1:
3
- metadata.gz: bb59350701b573d393c45047ebf2bd446ba73ded
4
- data.tar.gz: 7dce2b1ef5665e97850a5461e257f364300b8642
2
+ SHA256:
3
+ metadata.gz: 774f93a535c38c1531772ef1500f129bd90c44d8065c3f5fbd998766036a4926
4
+ data.tar.gz: 8060239041ea407ed13c38dc73d587dfd56d3cca081c2bca2d83d49218179d2f
5
5
  SHA512:
6
- metadata.gz: 0ed7b86ef1b0842c881f22286c5ef068eac6ee6efca90a5a384f68e666303882fe0b03b1620021cd0f972b61d7c40634b84962061a0e698f7c8ade755df0468c
7
- data.tar.gz: b2829bb2d9631bcee3c19d3ea779fcc330fcab336eedbc7dc87e198a7862377a9d7482e52ce154ec4b736a536c3d99b0b487d796cea69c36df1485137e75b38e
6
+ metadata.gz: 2e9a5b12265649ceb25428fb32cbfeae904b6a59eac073ab2b1f3448c118c01a221b1ab23fc80b054e32e902ee0ef2b4fdad8122f966b0b6f1418bbcd1a80b4f
7
+ data.tar.gz: 54f1da34b6f743bc102391bac1569fa5d3aea5d04a8fc1e175f7e259e869a5750e480be8c02b20ea9483412c6b9ec55bd756bd4af7dbee718761c5a787a01f47
data/README.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  *Time machine is a Jekyll theme for GitHub Pages. You can [preview the theme to see what it looks like](http://pages-themes.github.io/time-machine), or even [use it today](#usage).*
6
6
 
7
- ![Thumbnail of time-machine](thumbnail.png)
7
+ ![Thumbnail of Time machine](thumbnail.png)
8
8
 
9
9
  ## Usage
10
10
 
@@ -22,8 +22,6 @@ To use the Time machine 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,6 +65,23 @@ 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
+ ### Overriding GitHub-generated URLs
69
+
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
+
72
+ 1. Look at [the template source](https://github.com/pages-themes/time-machine/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.
80
+
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/).
84
+
68
85
  ## Roadmap
69
86
 
70
87
  See the [open issues](https://github.com/pages-themes/time-machine/issues) for a list of proposed features (and known issues).
@@ -75,7 +92,7 @@ The Time machine theme is intended to make it quick and easy for GitHub Pages us
75
92
 
76
93
  ## Contributing
77
94
 
78
- Interested in contributing to Time machine? We'd love your help. Time machine 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 Time machine? We'd love your help. Time machine 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
96
 
80
97
  ### Previewing the theme locally
81
98
 
data/_layouts/default.html CHANGED
@@ -4,16 +4,14 @@
4
4
  <html lang="{{ site.lang | default: "en-US" }}">
5
5
  <head>
6
6
  <meta charset="utf-8">
7
- <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
8
-
7
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
8
+ <meta name="viewport" content="width=device-width,initial-scale=1">
9
+
9
10
  <link rel="stylesheet" href="{{ '/assets/css/style.css?v=' | append: site.github.build_revision | relative_url }}">
10
- <script type="text/javascript" src="https://ajax.googleapis.com/ajax/libs/jquery/1.7.1/jquery.min.js"></script>
11
- <script type="text/javascript" src="{{ '/assets/js/script.js' | relative_url }}"></script>
11
+ <script src="https://code.jquery.com/jquery-1.12.4.min.js" integrity="sha256-ZosEbRLbNQzLpnKIkEdrPv7lOy9C27hHQ+Xp8a4MxAQ=" crossorigin="anonymous"></script>
12
+ <script src="{{ '/assets/js/script.js' | relative_url }}"></script>
12
13
 
13
14
  {% seo %}
14
- <meta name="description" content="{{ site.description | default: site.github.project_tagline }}">
15
-
16
- <meta name="viewport" content="width=device-width,initial-scale=1">
17
15
 
18
16
  </head>
19
17
 
@@ -64,7 +62,7 @@
64
62
  </div>
65
63
 
66
64
  {% if site.google_analytics %}
67
- <script type="text/javascript">
65
+ <script>
68
66
  (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
69
67
  (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
70
68
  m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: jekyll-theme-time-machine
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
  - Jon Rohan
@@ -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-time-machine@github.com
@@ -79,7 +121,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
79
121
  version: '0'
80
122
  requirements: []
81
123
  rubyforge_project:
82
- rubygems_version: 2.6.11
124
+ rubygems_version: 2.7.6
83
125
  signing_key:
84
126
  specification_version: 4
85
127
  summary: Time Machine is a Jekyll theme for GitHub Pages