picklecore 0.10.0 → 0.11.0
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.
- checksums.yaml +4 -4
- data/README.md +1 -137
- data/_includes/metadata/extra.html +0 -0
- data/_includes/metadata/metadata.html +4 -8
- metadata +7 -6
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 8cad9d181333a25aa09b840e5ffab13d68bcd93183b9a1156bc7bc4e1b020eb8
|
|
4
|
+
data.tar.gz: c1d239f34052eadfe799c2e39cee298a2d55c03088d2cb3e438885723b68bd94
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 696e4299a08805da28c1b3a9e26905a636525e3e3ad98fd3dc6ed4cabfb5bb794d2e18b845fe7c5f991cd5d81a3aff2e2c56cb7a9f4959e983ec7c44ca1ab56c
|
|
7
|
+
data.tar.gz: 19212d8b8980dbd9decb26c6be048ef938a8a3bac1858ef36050622f290c816c7145ee2172626e95084fb8fad39bc2864deea6b7404f1555c8e7c9d8e778f45d
|
data/README.md
CHANGED
|
@@ -2,140 +2,4 @@
|
|
|
2
2
|
|
|
3
3
|
*PickleCore* is a Jekyll theme developed by [Reece Dunham](https://github.com/RDIL) ([for his site](https://rdil.rocks)) and [Param Thakkar](https://github.com/paramt).
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
First, download it by adding it to your `Gemfile`:
|
|
8
|
-
|
|
9
|
-
```ruby
|
|
10
|
-
gem "picklecore"
|
|
11
|
-
```
|
|
12
|
-
|
|
13
|
-
run bundler:
|
|
14
|
-
|
|
15
|
-
```shell
|
|
16
|
-
$ bundler
|
|
17
|
-
```
|
|
18
|
-
|
|
19
|
-
and then apply it in your `_config.yml`:
|
|
20
|
-
|
|
21
|
-
```yaml
|
|
22
|
-
theme: picklecore
|
|
23
|
-
```
|
|
24
|
-
|
|
25
|
-
and it should apply.
|
|
26
|
-
|
|
27
|
-
## Deploying
|
|
28
|
-
|
|
29
|
-
### GitHub Pages
|
|
30
|
-
|
|
31
|
-
Unfortunately, PickleCore is not whitelisted as a GitHub pages theme, so you can't use it by simply applying the theme. You will need to set up some kind of pipeline that bulids the site into raw HTML/CSS/JS and deploy that off the `gh-pages` branch.
|
|
32
|
-
|
|
33
|
-
### Netlify
|
|
34
|
-
|
|
35
|
-
Netlify is perfect for deploying PickleCore. The setup is quite easy - just set the command as `bundler exec jekyll build` and set the deploy folder to `_site`!
|
|
36
|
-
|
|
37
|
-
## Customization
|
|
38
|
-
|
|
39
|
-
PickleCore is (probably) the most customizable theme out in the Jekyllverse. Here is a list of keys you can put in your `_config.yml` and what they do:
|
|
40
|
-
|
|
41
|
-
* `name` - the name of the site (main title)
|
|
42
|
-
* `webmanifest` - link to a `manifest.json` or a file with the `.webmanifest` extension (used by Google for web apps, link must be relative to the root page of the site)
|
|
43
|
-
* `description` - description of the site (for metadata)
|
|
44
|
-
* `url` - the URL of your site when hosted in production
|
|
45
|
-
* `apple-touch-icon` - the URL of the Apple touch icon for the site if you have one (see [this article](https://www.computerhope.com/jargon/a/appletou.htm) for more info)
|
|
46
|
-
* `index_on_google` - `true` or `false` depending if you want your site in Google search results
|
|
47
|
-
* `keywords` - an inline list of comma (no spaces) seperated keywords (for SEO) (e.g. `keywords: "hello,world,this,is,my,site"`)
|
|
48
|
-
* `images` - stuff for favicons
|
|
49
|
-
* Favicons - this requires multiple steps so read all sub-bullets
|
|
50
|
-
* `images.favicon_base` - route of where the favicons are served, e.g. `https://my.site/favicons/favicon-` (extension must be `PNG`)
|
|
51
|
-
* `images.favicons` - array of resolutions, e.g.:
|
|
52
|
-
```yaml
|
|
53
|
-
images:
|
|
54
|
-
favicons:
|
|
55
|
-
- "32" # 32x32
|
|
56
|
-
- "64" # 64x64
|
|
57
|
-
# and so on
|
|
58
|
-
```
|
|
59
|
-
* `images.tileimage` - the link to the Microsoft tile image
|
|
60
|
-
* `browserconfigxml` - link to a `browserconfig.xml` for Microsoft-based browsers
|
|
61
|
-
* The same thing can be applied to `twitter` with the subkey `image`, and `opengraph` with the subkey `image`
|
|
62
|
-
* `twitter` - Twitter meta dictionary
|
|
63
|
-
* `username`: your Twitter username as a string (no `@`!)
|
|
64
|
-
* `devto` - your [DEV](https://dev.to/) username (if you want it on the sidebar)
|
|
65
|
-
* `no_extra_css` - prevent custom stylesheets (see below) from being loaded (defaults to `false`)
|
|
66
|
-
|
|
67
|
-
Most of the favicons and images listed here can be made over at https://realfavicongenerator.net
|
|
68
|
-
|
|
69
|
-
### Colors
|
|
70
|
-
|
|
71
|
-
To change the base color, which defaults to `#303f9f`, you can add a file called `_includes/styling/theme-color.css`,
|
|
72
|
-
and put the hex color on the first line. **Do not** add a newline at the end of the file, it will break the CSS!
|
|
73
|
-
|
|
74
|
-
### Custom CSS
|
|
75
|
-
|
|
76
|
-
To apply custom CSS, add a file called `_includes/styling/extra.css` and put styles in that file.
|
|
77
|
-
|
|
78
|
-
Note: this will not work if you specify the `no_extra_css` key in your config.
|
|
79
|
-
|
|
80
|
-
## Applying Theme Components
|
|
81
|
-
|
|
82
|
-
The PickleCore theme allows you to apply some nice looking components that match with the theme via `includes`.
|
|
83
|
-
|
|
84
|
-
### Cards
|
|
85
|
-
|
|
86
|
-
[](https://github.com/RDIL/PickleCore)
|
|
87
|
-
|
|
88
|
-
A card (shown above) can be applied by adding the following to any page **with [Front Matter](https://jekyllrb.com/docs/front-matter/) on it**:
|
|
89
|
-
|
|
90
|
-
```html
|
|
91
|
-
<!--
|
|
92
|
-
Note: you can put as many cards as you want in each card container,
|
|
93
|
-
but all cards NEED to be in a container (with the class 'cards').
|
|
94
|
-
-->
|
|
95
|
-
<div class="cards">
|
|
96
|
-
<!-- In this container, render a card -->
|
|
97
|
-
{% include components/card.html cardtitle="My Card" cardbody="The text of the card!" %}
|
|
98
|
-
</div>
|
|
99
|
-
```
|
|
100
|
-
|
|
101
|
-
### Sidebar
|
|
102
|
-
|
|
103
|
-
The easiest way to apply the sidebar to your website is to use the `default-with-sidebar` layout via Jekyll:
|
|
104
|
-
|
|
105
|
-
```yaml
|
|
106
|
-
---
|
|
107
|
-
layout: default-with-sidebar
|
|
108
|
-
---
|
|
109
|
-
```
|
|
110
|
-
|
|
111
|
-
The second easiest way is to add it via the include:
|
|
112
|
-
|
|
113
|
-
```html
|
|
114
|
-
---
|
|
115
|
-
layout: default
|
|
116
|
-
---
|
|
117
|
-
<!--
|
|
118
|
-
Anchor the sidebar opener to this location on the page.
|
|
119
|
-
Note: trying to move it via CSS may prove difficult!
|
|
120
|
-
-->
|
|
121
|
-
{% include components/binds/sidebar-anchor.html %}
|
|
122
|
-
|
|
123
|
-
<!-- Other content -->
|
|
124
|
-
```
|
|
125
|
-
|
|
126
|
-
But you should ***most certainly not*** simply use the `sidebar.html` component without the anchor - this will most likely break everything. Use one of the methods above.
|
|
127
|
-
|
|
128
|
-
> *Help! My sidebar is blank when I open it - what do I do?*
|
|
129
|
-
> Certain site config fields will populate the sidebar, so see the customization section above.
|
|
130
|
-
|
|
131
|
-
### Solid Blocks
|
|
132
|
-
|
|
133
|
-
Sometimes you need to group data, or show something off, and a card just doesn't work. That's alright, you can just use the solid block element.
|
|
134
|
-
|
|
135
|
-
Example:
|
|
136
|
-
|
|
137
|
-
```html
|
|
138
|
-
<div class="block-solid">
|
|
139
|
-
<h2>I am in a block!</h2>
|
|
140
|
-
</div>
|
|
141
|
-
```
|
|
5
|
+
See [the documentation](https://docs.rdil.rocks/libraries/picklecore/) for more info.
|
|
File without changes
|
|
@@ -32,13 +32,6 @@
|
|
|
32
32
|
{% if site.apple-touch-icon %}
|
|
33
33
|
<link rel="apple-touch-icon" sizes="180x180" href="{{ site.apple-touch-icon }}">
|
|
34
34
|
{% endif %}
|
|
35
|
-
{% if site.favicons and site.faviconbase %}
|
|
36
|
-
<!--apply favicons-->
|
|
37
|
-
{% assign liststripped = site.favicons | compact %}
|
|
38
|
-
{% for resolution in liststripped %}
|
|
39
|
-
<link rel="icon" type="image/png" sizes="{{ resolution }}x{{ resolution }}" href="{{ site.faviconbase }}{{ resoultion }}x{{ resolution }}.png">
|
|
40
|
-
{% endfor %}
|
|
41
|
-
{% endif %}
|
|
42
35
|
{% if site.webmanifest %}
|
|
43
36
|
<link rel="manifest" href="{{ site.webmanifest }}">
|
|
44
37
|
{% endif %}
|
|
@@ -48,7 +41,7 @@
|
|
|
48
41
|
{% if site.browserconfigxml %}
|
|
49
42
|
<meta name="msapplication-config" content="{{ site.browserconfigxml }}">
|
|
50
43
|
{% endif %}
|
|
51
|
-
{% if site.
|
|
44
|
+
{% if site.images.tileimage %}
|
|
52
45
|
<meta name="msapplication-TileImage" content="{{ site.microsoft.tileimage }}">
|
|
53
46
|
{% endif %}
|
|
54
47
|
{% if site.opengraph.image %}
|
|
@@ -61,3 +54,6 @@
|
|
|
61
54
|
{% if site.twitter.image %}
|
|
62
55
|
<meta name="twitter:image" content="{{ site.twitter.image }}">
|
|
63
56
|
{% endif %}
|
|
57
|
+
{% unless site.no_extra_head %}
|
|
58
|
+
{% include metadata/extra.html %}
|
|
59
|
+
{% endunless %}
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: picklecore
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.11.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Reece Dunham
|
|
@@ -9,7 +9,7 @@ authors:
|
|
|
9
9
|
autorequire:
|
|
10
10
|
bindir: bin
|
|
11
11
|
cert_chain: []
|
|
12
|
-
date: 2019-
|
|
12
|
+
date: 2019-12-16 00:00:00.000000000 Z
|
|
13
13
|
dependencies:
|
|
14
14
|
- !ruby/object:Gem::Dependency
|
|
15
15
|
name: jekyll
|
|
@@ -65,14 +65,14 @@ dependencies:
|
|
|
65
65
|
requirements:
|
|
66
66
|
- - '='
|
|
67
67
|
- !ruby/object:Gem::Version
|
|
68
|
-
version: 2.0
|
|
68
|
+
version: 2.1.0
|
|
69
69
|
type: :development
|
|
70
70
|
prerelease: false
|
|
71
71
|
version_requirements: !ruby/object:Gem::Requirement
|
|
72
72
|
requirements:
|
|
73
73
|
- - '='
|
|
74
74
|
- !ruby/object:Gem::Version
|
|
75
|
-
version: 2.0
|
|
75
|
+
version: 2.1.0
|
|
76
76
|
- !ruby/object:Gem::Dependency
|
|
77
77
|
name: rake
|
|
78
78
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -99,6 +99,7 @@ files:
|
|
|
99
99
|
- _includes/components/binds/sidebar-anchor.html
|
|
100
100
|
- _includes/components/card.html
|
|
101
101
|
- _includes/components/sidebar.html
|
|
102
|
+
- _includes/metadata/extra.html
|
|
102
103
|
- _includes/metadata/metadata.html
|
|
103
104
|
- _includes/styling/extra.css
|
|
104
105
|
- _includes/styling/font.css
|
|
@@ -141,9 +142,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
141
142
|
- !ruby/object:Gem::Version
|
|
142
143
|
version: '0'
|
|
143
144
|
requirements: []
|
|
144
|
-
rubygems_version: 3.
|
|
145
|
+
rubygems_version: 3.1.1
|
|
145
146
|
signing_key:
|
|
146
147
|
specification_version: 4
|
|
147
|
-
summary: A Jekyll theme built to
|
|
148
|
+
summary: A Jekyll theme built to create personal and small websites, but can easily
|
|
148
149
|
scale!
|
|
149
150
|
test_files: []
|