panthera-jekyll 1.0.2 → 1.0.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +93 -15
- data/_includes/left.html +1 -1
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: ac455459dc6d9801a6ffbff78c69b80ba2f60d21437d2b29c5a2e1fb120620a8
|
|
4
|
+
data.tar.gz: 56bec00b4d03ba3dcf7d7b3e87755110c86565dcf4aba37521f66dc17b304c53
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 6e02692a85736720bf6572880e657bbdf67c0e222058944bb72814d9882b1129786c11b58fb93da14e65322fd2b8780b37b596329a943804c9177fd90a6a9477
|
|
7
|
+
data.tar.gz: be9b84d7a74051045736255a805c82700cfec22562475316bd2a541f168865238eb8d3129856f9633790bc434179f30bffa61b2b37c33f865f6581ed3c2bc07c
|
data/README.md
CHANGED
|
@@ -1,16 +1,14 @@
|
|
|
1
1
|
# panthera-jekyll
|
|
2
2
|
|
|
3
3
|
[](https://badge.fury.io/rb/panthera-jekyll)
|
|
4
|
+
[](code-of-conduct.md)
|
|
4
5
|
|
|
5
|
-
|
|
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
|
|
10
|
-
|
|
6
|
+
*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).*
|
|
11
7
|
|
|
12
8
|
## Installation
|
|
13
9
|
|
|
10
|
+
### Building a Jekyll Site
|
|
11
|
+
|
|
14
12
|
Add this line to your Jekyll site's `Gemfile`:
|
|
15
13
|
|
|
16
14
|
```ruby
|
|
@@ -31,22 +29,102 @@ Or install it yourself as:
|
|
|
31
29
|
|
|
32
30
|
$ gem install panthera-jekyll
|
|
33
31
|
|
|
34
|
-
|
|
32
|
+
### Building a Github Page
|
|
35
33
|
|
|
36
|
-
|
|
34
|
+
Add this line to your Github Page's `_config.yml`:
|
|
37
35
|
|
|
38
|
-
|
|
36
|
+
```yaml
|
|
37
|
+
remote_theme: christianezeani/panthera-jekyll
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
## Customizing
|
|
39
41
|
|
|
40
|
-
|
|
42
|
+
### Configuration variables
|
|
41
43
|
|
|
42
|
-
|
|
44
|
+
panthera-jekyll will respect the following variables, if set in your site's `_config.yml`:
|
|
45
|
+
|
|
46
|
+
```yml
|
|
47
|
+
title: [The title of your site or Profile Name]
|
|
48
|
+
subtitle: [A brief subtitle or job title]
|
|
49
|
+
description: [A short description of your site's purpose]
|
|
50
|
+
```
|
|
43
51
|
|
|
44
|
-
To
|
|
52
|
+
To configure side menu, set the following variables:
|
|
53
|
+
|
|
54
|
+
```yml
|
|
55
|
+
menu:
|
|
56
|
+
- text: [Menu text]
|
|
57
|
+
link: [Relative page link with the '/' prefix]
|
|
58
|
+
icon: [Menu Icon]
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
#### Example
|
|
62
|
+
|
|
63
|
+
```yml
|
|
64
|
+
menu:
|
|
65
|
+
- text: Portfolio
|
|
66
|
+
link: /
|
|
67
|
+
icon: ""
|
|
68
|
+
|
|
69
|
+
- text: Skills & Offers
|
|
70
|
+
link: /skills-and-offers
|
|
71
|
+
icon: ""
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
To configure social links, set the following variables:
|
|
75
|
+
|
|
76
|
+
```yml
|
|
77
|
+
social_icons:
|
|
78
|
+
- name: [Socialmedia title]
|
|
79
|
+
link: [Social link]
|
|
80
|
+
icon: [Icon class]
|
|
81
|
+
```
|
|
45
82
|
|
|
46
|
-
|
|
83
|
+
#### Example
|
|
84
|
+
|
|
85
|
+
```yml
|
|
86
|
+
social_icons:
|
|
87
|
+
- name: linkedin
|
|
88
|
+
link: https://www.linkedin.com/christianezeani
|
|
89
|
+
icon: fab fa-linkedin
|
|
90
|
+
|
|
91
|
+
- name: github
|
|
92
|
+
link: https://github.com/christianezeani
|
|
93
|
+
icon: fab fa-github-square
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
panthera-jekyll currently supports the following icons:
|
|
97
|
+
|
|
98
|
+
* [FontAwesome](https://fontawesome.com) (version 5.9.0)
|
|
99
|
+
|
|
100
|
+
Additionally, you may choose to set the following optional variables:
|
|
101
|
+
|
|
102
|
+
```yml
|
|
103
|
+
google_analytics: [Your Google Analytics tracking ID]
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
### Stylesheet
|
|
107
|
+
|
|
108
|
+
If you'd like to add your own custom styles:
|
|
109
|
+
|
|
110
|
+
1. Create a file called `/assets/css/style.scss` in your site
|
|
111
|
+
|
|
112
|
+
2. Add the following content to the top of the file, exactly as shown:
|
|
113
|
+
|
|
114
|
+
```scss
|
|
115
|
+
---
|
|
116
|
+
---
|
|
117
|
+
|
|
118
|
+
@import "panthera-jekyll";
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
3. Add any custom CSS (or Sass, including imports) you'd like immediately after the `@import` line
|
|
122
|
+
|
|
123
|
+
*Note: If you'd like to change the theme's Sass variables, you must set new values before the `@import` line in your stylesheet.*
|
|
124
|
+
|
|
125
|
+
## Contributing
|
|
47
126
|
|
|
48
|
-
|
|
49
|
-
To add a custom directory to your theme-gem, please edit the regexp in `panthera-jekyll.gemspec` accordingly.
|
|
127
|
+
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](http://contributor-covenant.org) code of conduct.
|
|
50
128
|
|
|
51
129
|
## License
|
|
52
130
|
|
data/_includes/left.html
CHANGED
|
@@ -40,7 +40,7 @@
|
|
|
40
40
|
<div class="pan-layout-left__social">
|
|
41
41
|
{% if site.social %}
|
|
42
42
|
<ul>
|
|
43
|
-
{% for social in site.
|
|
43
|
+
{% for social in site.social_icons %}
|
|
44
44
|
{% if social.icon %}
|
|
45
45
|
<li><a target="_blank" href="{{ social.link }}"><i class="{{ social.icon }}"></i></a></li>
|
|
46
46
|
{% endif %}
|