panthera-jekyll 1.0.1 → 1.1.1

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: 6548a583b7d5d02031bcfbf9812791a23779a1b3d53bfbfa2b7140efb18872c1
4
- data.tar.gz: 6ae7ac207a416e586ab44b15832e058e3b7482683dfd7856aefef6d2dfc0f53c
3
+ metadata.gz: 8378c999584abc7ba7e42be307c521e2b2f6fd9af035913d61b93d7c0e70fd2b
4
+ data.tar.gz: 0be50858cc0e461d6034cfb2eb51e972d3c418a25692d7dc750f5284ca706360
5
5
  SHA512:
6
- metadata.gz: e1805e63d17c1d5148ecdfd29acd9ea011f502d8701461aa1e01fbdb0fe5b2c18c629ad38acd8fbd9b4ec32365f49bbac44bd2dbb738e2330c77c790449d4f65
7
- data.tar.gz: 68986b1d5a1813483bda3d69a3329becdd14e8872753c4d06526ec54da837ce5aedf346edd945839740ede6e4ee430a6b5d8f39a65ec040439922216c38ba399
6
+ metadata.gz: 787d624fd0b095ec10f77fef71f5add820aaa737403edc0ebe1ef45cf2137cdb5cfcdd5b0a492c6868b9dde97dea52750deec22f84a8e5867ba97c14197f89a3
7
+ data.tar.gz: 04eaa149b2c5b3ebce5ad9ad09642b071e21a1185199907d92223f63a1710adc9950b684ac01409a219009904b078ad43261fb30d04b8fe730178a7ebd0803ad
data/README.md CHANGED
@@ -1,16 +1,19 @@
1
1
  # panthera-jekyll
2
2
 
3
3
  [![Gem Version](https://badge.fury.io/rb/panthera-jekyll.svg)](https://badge.fury.io/rb/panthera-jekyll)
4
+ [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v1.4%20adopted-ff69b4.svg)](code-of-conduct.md)
5
+ <!-- [![Jekyll Themes Shield](https://img.shields.io/badge/featured%20on-JT-red.svg)](https://jekyll-themes.com) -->
4
6
 
5
- Welcome to your new Jekyll theme! In this directory, you'll find the files you need to be able to package up your theme into a gem. Put your layouts in `_layouts`, your includes in `_includes`, your sass files in `_sass` and any other assets in `assets`.
6
-
7
- To experiment with this code, add some sample content and run `bundle exec jekyll serve` – this directory is setup just like a Jekyll site!
8
-
9
- TODO: Delete this and the text above, and describe your gem
7
+ *panthera-jekyll is a Jekyll theme for GitHub Pages and Jekyll sites. You can [preview the theme to see what it looks like](https://demothemes.github.io/panthera-jekyll), or even [use it today](#usage).*
10
8
 
9
+ <div style="text-align: center;">
10
+ <img src="/screenshot.png" alt="panthera-jekyll" style="width: 100%; max-width: 750px;" />
11
+ </div>
11
12
 
12
13
  ## Installation
13
14
 
15
+ ### Building a Jekyll Site
16
+
14
17
  Add this line to your Jekyll site's `Gemfile`:
15
18
 
16
19
  ```ruby
@@ -31,22 +34,130 @@ Or install it yourself as:
31
34
 
32
35
  $ gem install panthera-jekyll
33
36
 
34
- ## Usage
37
+ ### Building a Github Page
35
38
 
36
- TODO: Write usage instructions here. Describe your available layouts, includes, sass and/or assets.
39
+ Add this line to your Github Page's `_config.yml`:
37
40
 
38
- ## Contributing
41
+ ```yaml
42
+ remote_theme: christianezeani/panthera-jekyll
43
+ ```
39
44
 
40
- Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/hello. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
45
+ ## Customizing
41
46
 
42
- ## Development
47
+ ### Configuration variables
48
+
49
+ panthera-jekyll will respect the following variables, if set in your site's `_config.yml`:
50
+
51
+ ```yml
52
+ title: [The title of your site or Profile Name]
53
+ subtitle: [A brief subtitle or job title]
54
+ description: [A short description of your site's purpose]
55
+ ```
56
+
57
+ To configure the left side set the following variables as shown below:
58
+
59
+ ```yml
60
+ left_side:
61
+ background_image: [Absolute or relative image url]
62
+ background_color: [CSS background color, e.g. "#F00". We strongly recommend quoting this value. Don't worry about the transparency of the background, we've taken care of that.]
63
+ close_button_color: [CSS background color, e.g. "#F00". We strongly recommend quoting this value.]
64
+ text_color: [CSS background color, e.g. "#F00". We strongly recommend quoting this value.]
65
+ ```
43
66
 
44
- To set up your environment to develop this theme, run `bundle install`.
67
+ #### Example
45
68
 
46
- Your theme is setup just like a normal Jekyll site! To test your theme, run `bundle exec jekyll serve` and open your browser at `http://localhost:4000`. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.
69
+ ```yml
70
+ left_side:
71
+ background_image: "./assets/images/left-background.jpg"
72
+ background_color: "#F00"
73
+ close_button_color: "#F00"
74
+ text_color: "#F00"
75
+ ```
76
+
77
+ To configure side menu, set the following variables:
78
+
79
+ ```yml
80
+ menu:
81
+ - text: [Menu text]
82
+ link: [Relative page link with the '/' prefix]
83
+ icon: [Menu Icon]
84
+ ```
85
+
86
+ #### Example
87
+
88
+ ```yml
89
+ menu:
90
+ - text: Portfolio
91
+ link: /
92
+ icon: ""
93
+
94
+ - text: Skills & Offers
95
+ link: /skills-and-offers
96
+ icon: ""
97
+ ```
98
+
99
+ To configure social links, set the following variables:
100
+
101
+ ```yml
102
+ social_icons:
103
+ - name: [Socialmedia title]
104
+ link: [Social link]
105
+ icon: [Icon class]
106
+ ```
107
+
108
+ #### Example
109
+
110
+ ```yml
111
+ social_icons:
112
+ - name: linkedin
113
+ link: https://www.linkedin.com/christianezeani
114
+ icon: fab fa-linkedin
115
+
116
+ - name: github
117
+ link: https://github.com/christianezeani
118
+ icon: fab fa-github-square
119
+ ```
120
+
121
+ To configure footer, set the following variables:
122
+
123
+ ```yml
124
+ footer:
125
+ copyright_text: [The copyright text. Value should be quoted]
126
+ ```
127
+
128
+ #### Example
129
+
130
+ ```yml
131
+ footer:
132
+ copyright_text: "&copy; Christian Ezeani"
133
+ ```
134
+
135
+ panthera-jekyll currently supports the following icons:
136
+
137
+ * [FontAwesome](https://fontawesome.com) (version 5.9.0)
138
+
139
+ ### Stylesheet
140
+
141
+ If you'd like to add your own custom styles:
142
+
143
+ 1. Create a file called `/assets/css/style.scss` in your site
144
+
145
+ 2. Add the following content to the top of the file, exactly as shown:
146
+
147
+ ```scss
148
+ ---
149
+ ---
150
+
151
+ @import "panthera-jekyll";
152
+ ```
153
+
154
+ 3. Add any custom CSS (or Sass, including imports) you'd like immediately after the `@import` line
155
+
156
+ *Note: If you'd like to change the theme's Sass variables, you must set new values before the `@import` line in your stylesheet.*
157
+
158
+ ## Contributing
47
159
 
48
- When your theme is released, only the files in `_layouts`, `_includes`, `_sass` and `assets` tracked with Git will be bundled.
49
- To add a custom directory to your theme-gem, please edit the regexp in `panthera-jekyll.gemspec` accordingly.
160
+ Bug reports and pull requests are welcome on GitHub at https://github.com/chrisitanezeani/panthera-jekyll. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](https://contributor-covenant.org) code of conduct.
50
161
 
51
162
  ## License
52
163
 
@@ -1,5 +1,10 @@
1
1
  <section class="pan-layout-footer">
2
2
  <div class="pan-layout-footer-right">
3
- <div>Theme developed by <a target="_blank" href="https://github.com/christianezeani">Christian Ezeani</a>.</div>
3
+ <div>
4
+ {% if site.footer %}
5
+ <span class="pan-layout-footer__copyright">{{ site.footer.copyright_text }}</span>
6
+ {% endif %}
7
+ <span>Theme developed by <a target="_blank" href="https://github.com/christianezeani">Christian Ezeani</a>.</span>
8
+ </div>
4
9
  </div>
5
10
  </section>
@@ -1,4 +1,23 @@
1
- <section class="pan-layout-left">
1
+ <section
2
+ class="pan-layout-left"
3
+ {% if site.left_side %}
4
+ style="
5
+ {% if site.left_side.background_image %}
6
+ background-image: url({{ site.left_side.background_image }});
7
+ {% endif %}
8
+ {% if site.left_side.text_color %}
9
+ color: {{ site.left_side.text_color }};
10
+ {% endif %}
11
+ "
12
+ {% endif %}
13
+ >
14
+ <section
15
+ class="pan-layout-left__overlay"
16
+ {% if site.left_side %}
17
+ style="{% if site.left_side.background_color %}background-color: {{ site.left_side.background_color }} !important;{% endif %}"
18
+ {% endif %}
19
+ ></section>
20
+
2
21
  <div class="pan-layout-left__top">
3
22
  <div class="pan-layout-left__avatar">
4
23
  {% if site.github.owner_gravatar_url %}
@@ -38,9 +57,9 @@
38
57
  <span>GET IN TOUCH</span>
39
58
  </div>
40
59
  <div class="pan-layout-left__social">
41
- {% if site.social %}
60
+ {% if site.social_icons %}
42
61
  <ul>
43
- {% for social in site.social %}
62
+ {% for social in site.social_icons %}
44
63
  {% if social.icon %}
45
64
  <li><a target="_blank" href="{{ social.link }}"><i class="{{ social.icon }}"></i></a></li>
46
65
  {% endif %}
@@ -50,7 +69,12 @@
50
69
  </div>
51
70
  </div>
52
71
 
53
- <div class="pan-layout-left__close">
72
+ <div
73
+ class="pan-layout-left__close"
74
+ {% if site.left_side %}
75
+ style="{% if site.left_side.close_button_color %}color: {{ site.left_side.close_button_color }} !important;{% endif %}"
76
+ {% endif %}
77
+ >
54
78
  <i class="fa fa-fw fa-times"></i>
55
79
  </div>
56
80
  </section>
@@ -38,19 +38,9 @@
38
38
  </section>
39
39
  </section>
40
40
 
41
- <script type="text/javascript" src="/assets/libs/jquery-3.4.1.min.js"></script>
42
- <script type="text/javascript" src="/assets/libs/jquery-migrate-3.0.1.min.js"></script>
41
+ <script type="text/javascript" src="{{ '/assets/libs/jquery-3.4.1.min.js' | relative_url }}"></script>
42
+ <script type="text/javascript" src="{{ '/assets/libs/jquery-migrate-3.0.1.min.js' | relative_url }}"></script>
43
43
  <script type="text/javascript" src="{{ '/assets/js/panthera-jekyll.js?v=' | append: site.github.build_revision | relative_url }}"></script>
44
-
45
- {% if site.google_analytics %}
46
- <script>
47
- (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
48
- (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
49
- m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
50
- })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
51
- ga('create', '{{ site.google_analytics }}', 'auto');
52
- ga('send', 'pageview');
53
- </script>
54
- {% endif %}
44
+
55
45
  </body>
56
46
  </html>
@@ -17,4 +17,18 @@
17
17
  padding: 0px 20px;
18
18
  }
19
19
 
20
+ &__copyright {
21
+ display: inline-block;
22
+ border-right: 1px solid #CCC;
23
+ padding-right: 10px;
24
+ margin-right: 10px;
25
+ }
26
+
27
+ @media (min-width: pan-device(md)) {
28
+ &__copyright {
29
+ float: left;
30
+ border-right: none;
31
+ }
32
+ }
33
+
20
34
  }
@@ -13,23 +13,25 @@
13
13
  color: #FFF;
14
14
  z-index: 100500;
15
15
 
16
- &:before {
16
+ &__overlay {
17
17
  display: block;
18
18
  position: absolute;
19
19
  top: 0px;
20
20
  bottom: 0px;
21
21
  left: 0px;
22
22
  right: 0px;
23
- content: "";
24
23
  background-color: var(--pan-layout-left-background-color);
24
+ opacity: .7;
25
25
  }
26
26
 
27
27
  > * {
28
28
  position: absolute;
29
29
  left: 0px;
30
30
  right: 0px;
31
+ z-index: 2;
31
32
  }
32
33
 
34
+
33
35
  h1,h2,h3,h4,h5,h6 {
34
36
  margin: 0px;
35
37
  }
@@ -90,7 +92,7 @@
90
92
  margin: 0px;
91
93
 
92
94
  a {
93
- color: #FFF;
95
+ color: inherit !important;
94
96
  }
95
97
  }
96
98
  }
@@ -159,7 +161,7 @@
159
161
  > a {
160
162
  display: block;
161
163
  padding: 15px 15px 15px 30px;
162
- color: #FFF !important;
164
+ color: inherit !important;
163
165
  text-decoration: none !important;
164
166
  }
165
167
  }
@@ -168,6 +170,7 @@
168
170
  &__close {
169
171
  left: unset;
170
172
  top: 0px;
173
+ right: 10px;
171
174
  padding: 10px 15px;
172
175
  color: #FFF;
173
176
  cursor: pointer;
@@ -4,7 +4,7 @@
4
4
 
5
5
  --pan-layout-left-width: 100vw;
6
6
  --pan-layout-left-left: calc(var(--pan-layout-left-width) * -1);
7
- --pan-layout-left-background-color: rgba(0, 122, 204, .7);
7
+ --pan-layout-left-background-color: rgb(0, 122, 204);
8
8
  --pan-layout-left-background-image: url(../images/left-background.jpg);
9
9
  --pan-layout-left-top-height: 300px;
10
10
  --pan-layout-left-bottom-height: 70px;
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: panthera-jekyll
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.1
4
+ version: 1.1.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Christian Ezeani
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2019-06-09 00:00:00.000000000 Z
11
+ date: 2020-06-24 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: jekyll
@@ -379,10 +379,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
379
379
  - !ruby/object:Gem::Version
380
380
  version: '0'
381
381
  requirements: []
382
- rubyforge_project:
383
- rubygems_version: 2.7.6.2
382
+ rubygems_version: 3.0.3
384
383
  signing_key:
385
384
  specification_version: 4
386
- summary: This template is a quick and simple responsive developer portfolio theme
387
- for GitHub Pages.
385
+ summary: A quick and simple responsive developer portfolio theme for jekyll sites
386
+ and GitHub Pages.
388
387
  test_files: []