jekyll-theme-8bit 0.2.0 → 0.3.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +92 -2
- data/_includes/head.html +1 -1
- data/_sass/jekyll-theme-8bit.scss +16 -18
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 8ec97781fa67bbe804265c40753413cae31aecbf21462c3f5f5af61834c44e3e
|
|
4
|
+
data.tar.gz: 7b5034c3a8a1943317e8497466b120a1c33c0a016152ec6f68aad93ab6f3d659
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: d992f2a3956dd8b0197af9c2c9c83da11be6a5170f6b9f4838bde91da59bf83be2c98f0d3d933e1bb6bf5d1eccab4823a19aa135089b5d56c30425bc7ec329fd
|
|
7
|
+
data.tar.gz: 7e280811377252b45e68b552837d611e356b39830b18f74ae5d63441a80437e52693eaa56c8fe45c98ffad4531d7955db123eb5b456b59b776a5e3acd56d44c7
|
data/README.md
CHANGED
|
@@ -1,9 +1,13 @@
|
|
|
1
1
|
# jekyll-theme-8bit
|
|
2
2
|
|
|
3
|
-
[](https://travis-ci.org/julianolf/jekyll-theme-8bit)
|
|
3
|
+
[](https://travis-ci.org/julianolf/jekyll-theme-8bit) [](https://badge.fury.io/rb/jekyll-theme-8bit)
|
|
4
4
|
|
|
5
5
|
A Jekyll theme inspired by classic 8bit games.
|
|
6
6
|
|
|
7
|
+
## Preview
|
|
8
|
+
|
|
9
|
+
You can see how the theme looks like [here](http://julianofernandes.com.br/jekyll-theme-8bit/).
|
|
10
|
+
|
|
7
11
|
## Installation
|
|
8
12
|
|
|
9
13
|
Add this line to your Jekyll site's `Gemfile`:
|
|
@@ -26,9 +30,92 @@ Or install it yourself as:
|
|
|
26
30
|
|
|
27
31
|
$ gem install jekyll-theme-8bit
|
|
28
32
|
|
|
33
|
+
## Contents
|
|
34
|
+
|
|
35
|
+
**jekyll-theme-8bit** has been scaffolded by the `jekyll new-theme` command and therefore has all the necessary files and directories to have a new Jekyll site up and running with zero-configuration.
|
|
36
|
+
|
|
37
|
+
### Layouts
|
|
38
|
+
|
|
39
|
+
Refers to files within the `_layouts` directory, that define the markup for your theme.
|
|
40
|
+
|
|
41
|
+
- `default.html` — The base layout that lays the foundation for subsequent layouts. The derived layouts inject their contents into this file at the line that says `{{ content }}` and are linked to this file via [FrontMatter](https://jekyllrb.com/docs/frontmatter/) declaration `layout: default`.
|
|
42
|
+
- `post.html` — The layout for your posts.
|
|
43
|
+
|
|
44
|
+
### Includes
|
|
45
|
+
|
|
46
|
+
Refers to snippets of code within the `_includes` directory that can be inserted in multiple layouts (and another include-file as well) within the same theme-gem.
|
|
47
|
+
|
|
48
|
+
- `downloads.html` — Insert download buttons when using the theme on a project with GitHub Pages enabled and the `show_downloads` variable set to *true* in `_config.yml`.
|
|
49
|
+
- `footer.html` — Defines the site's footer section.
|
|
50
|
+
- `fork-me.html` — Shows a *"Fork me on GitHub"* link when using the theme on a project with GitHub Pages enabled.
|
|
51
|
+
- `google-analytics.html` — Inserts Google Analytics module (active only in production environment).
|
|
52
|
+
- `head.html` — Code-block that defines the `<head></head>` in _default_ layout.
|
|
53
|
+
- `header.html` — Defines the site's main header section. By default, pages with a defined `title` attribute will have links displayed here.
|
|
54
|
+
- `social.html` — Icons for social networks. Wich icons will be visible depends on what was defined in `_config.yml`.
|
|
55
|
+
|
|
56
|
+
### SASS
|
|
57
|
+
|
|
58
|
+
Refers to `.scss` files within the `_sass` directory that define the theme's styles.
|
|
59
|
+
|
|
60
|
+
- `fonts.scss` — Defines font faces used by 8bit's theme.
|
|
61
|
+
- `jekyll-theme-8bit.scss` — The core file imported by preprocessed `assets/css/style.scss`, it defines the defaults for the theme, layout, etc, and also further imports sass partials to supplement itself.
|
|
62
|
+
- `rouge-github.scss` — Defines the styles for syntax-highlighting.
|
|
63
|
+
|
|
64
|
+
### Assets
|
|
65
|
+
|
|
66
|
+
Refers to various asset files within the `assets` directory.
|
|
67
|
+
|
|
68
|
+
- `css/style.scss` — Imports sass files from within the `_sass` directory. It is what gets processed into the theme's main stylesheet `main.css` called by `_layouts/default.html` via `_includes/head.html`.
|
|
69
|
+
- `fonts/Press-Start-2P/` — The directory contains font files for *ttf*, *woff* and *woff2* formats.
|
|
70
|
+
- `js/scale-fix.js` — Zooming scale fix for iPhone.
|
|
71
|
+
|
|
72
|
+
This directory can include sub-directories to manage assets of similar type (`img`, `fonts`, `svg`), and will be copied over as is, to the final transformed site directory.
|
|
73
|
+
|
|
74
|
+
### Plugins
|
|
75
|
+
|
|
76
|
+
**jekyll-theme-8bit** comes with two plugins preinstalled.
|
|
77
|
+
|
|
78
|
+
- [`jekyll-paginate`](https://jekyllrb.com/docs/pagination/) — Allows break the main listing of posts up into smaller lists and display them over multiple pages. See [documentation](https://jekyllrb.com/docs/pagination/) for more details.
|
|
79
|
+
- [`jekyll-seo-tag`](https://github.com/jekyll/jekyll-seo-tag) — Ensure your website gets the most useful meta tags. See [usage](https://github.com/jekyll/jekyll-seo-tag/blob/master/docs/usage.md) to know how to set it up.
|
|
80
|
+
|
|
29
81
|
## Usage
|
|
30
82
|
|
|
31
|
-
|
|
83
|
+
### Customization
|
|
84
|
+
|
|
85
|
+
For details on how to customize the layout, style and configurations head to [Jekyll](https://jekyllrb.com/docs/themes/) documentation, it has detailed information about everything you might need.
|
|
86
|
+
|
|
87
|
+
So far 8bit theme specific customizations are only available through entries in `_config.yml`.
|
|
88
|
+
|
|
89
|
+
#### Custom logo
|
|
90
|
+
|
|
91
|
+
Set **logo** entry in `_config.yml`. It accepts an image path like `assets/img/logo.png` or one of the available Nintendo characters provided by [NES.css](https://nostalgic-css.github.io/NES.css/): `nes-mario`, `nes-ash`, `nes-pokeball`, `nes-bulbasaur`, `nes-charmander`, `nes-squirtle`, `nes-kirby`.
|
|
92
|
+
|
|
93
|
+
**PS**.: Nintendo owns the copyright of these characters. Please comply with the Nintendo guidelines and laws of the applicable jurisdiction.
|
|
94
|
+
|
|
95
|
+
#### Show download buttons
|
|
96
|
+
|
|
97
|
+
If you’re publishing on GitHub Pages for a project you can enable the download buttons by just setting `show_downloads: true` in `_config.yml`.
|
|
98
|
+
|
|
99
|
+
#### Social networks
|
|
100
|
+
|
|
101
|
+
You can show links for accounts you have on some of the most popular social networks. See the example below with the complete list of available networks.
|
|
102
|
+
|
|
103
|
+
```yaml
|
|
104
|
+
# file: _config.yml
|
|
105
|
+
|
|
106
|
+
social:
|
|
107
|
+
twitter: https://twitter.com/username
|
|
108
|
+
facebook: https://facebook.com/username
|
|
109
|
+
github: https://github.com/username
|
|
110
|
+
youtube: https://youtube.com/channel/ID
|
|
111
|
+
google: https://plus.google.com/username
|
|
112
|
+
medium: https://medium.com/@username
|
|
113
|
+
twitch: https://twitch.com/username
|
|
114
|
+
reddit: https://www.reddit.com/user/username
|
|
115
|
+
whatsapp: tel:+5541999999999
|
|
116
|
+
gmail: mailto:username@domain.net
|
|
117
|
+
linkedin: https://www.linkedin.com/in/username
|
|
118
|
+
```
|
|
32
119
|
|
|
33
120
|
## Contributing
|
|
34
121
|
|
|
@@ -47,3 +134,6 @@ To add a custom directory to your theme-gem, please edit the regexp in `jekyll-t
|
|
|
47
134
|
|
|
48
135
|
The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
|
|
49
136
|
|
|
137
|
+
## Credits
|
|
138
|
+
|
|
139
|
+
- 8bit style by [NES.css](https://nostalgic-css.github.io/NES.css/)
|
data/_includes/head.html
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
4
4
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
5
5
|
{% seo %}
|
|
6
|
-
<link rel="stylesheet" href="https://unpkg.com/nes.css@1.
|
|
6
|
+
<link rel="stylesheet" href="https://unpkg.com/nes.css@2.1.1/css/nes.min.css" />
|
|
7
7
|
<link rel="stylesheet" href="{{ "/assets/css/style.css?v=" | append: site.github.build_revision | relative_url }}">
|
|
8
8
|
<!--[if lt IE 9]>
|
|
9
9
|
<script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv.min.js"></script>
|
|
@@ -118,25 +118,20 @@ footer {
|
|
|
118
118
|
bottom: 50px;
|
|
119
119
|
}
|
|
120
120
|
|
|
121
|
-
.nes-container.
|
|
122
|
-
|
|
123
|
-
0 -4px #3fbfff, 0 -8px #1a80b2, 4px 0 #1a80b2, 4px -4px #1a80b2,
|
|
124
|
-
8px 0 #3fbfff, 0 4px #1a80b2, 0 8px #3fbfff, -4px 0 #3fbfff,
|
|
125
|
-
-4px 4px #1a80b2, -8px 0 #1a80b2, -4px -4px #1a80b2, 4px 4px #3fbfff;
|
|
121
|
+
.nes-container.is-rounded {
|
|
122
|
+
margin-top: 8px;
|
|
126
123
|
}
|
|
127
124
|
|
|
128
|
-
.nes-container.
|
|
129
|
-
|
|
130
|
-
0 -4px #01b801, 0 -8px #007800, 4px 0 #007800, 4px -4px #007800,
|
|
131
|
-
8px 0 #01b801, 0 4px #007800, 0 8px #01b801, -4px 0 #01b801,
|
|
132
|
-
-4px 4px #007800, -8px 0 #007800, -4px -4px #007800, 4px 4px #01b801;
|
|
125
|
+
.nes-container.blue-border {
|
|
126
|
+
border-image-source: url('data:image/svg+xml;utf8,<?xml version="1.0" encoding="UTF-8" ?><svg version="1.1" width="8" height="8" xmlns="http://www.w3.org/2000/svg"><path d="M3 1 h1 v1 h-1 z M4 1 h1 v1 h-1 z M2 2 h1 v1 h-1 z M5 2 h1 v1 h-1 z M1 3 h1 v1 h-1 z M6 3 h1 v1 h-1 z M1 4 h1 v1 h-1 z M6 4 h1 v1 h-1 z M2 5 h1 v1 h-1 z M5 5 h1 v1 h-1 z M3 6 h1 v1 h-1 z M4 6 h1 v1 h-1 z" fill="rgb(26,128,178)" /></svg>');
|
|
133
127
|
}
|
|
134
128
|
|
|
135
|
-
.nes-container.
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
129
|
+
.nes-container.green-border {
|
|
130
|
+
border-image-source: url('data:image/svg+xml;utf8,<?xml version="1.0" encoding="UTF-8" ?><svg version="1.1" width="8" height="8" xmlns="http://www.w3.org/2000/svg"><path d="M3 1 h1 v1 h-1 z M4 1 h1 v1 h-1 z M2 2 h1 v1 h-1 z M5 2 h1 v1 h-1 z M1 3 h1 v1 h-1 z M6 3 h1 v1 h-1 z M1 4 h1 v1 h-1 z M6 4 h1 v1 h-1 z M2 5 h1 v1 h-1 z M5 5 h1 v1 h-1 z M3 6 h1 v1 h-1 z M4 6 h1 v1 h-1 z" fill="rgb(0,120,0)" /></svg>');
|
|
131
|
+
}
|
|
132
|
+
|
|
133
|
+
.nes-container.brown-border {
|
|
134
|
+
border-image-source: url('data:image/svg+xml;utf8,<?xml version="1.0" encoding="UTF-8" ?><svg version="1.1" width="8" height="8" xmlns="http://www.w3.org/2000/svg"><path d="M3 1 h1 v1 h-1 z M4 1 h1 v1 h-1 z M2 2 h1 v1 h-1 z M5 2 h1 v1 h-1 z M1 3 h1 v1 h-1 z M6 3 h1 v1 h-1 z M1 4 h1 v1 h-1 z M6 4 h1 v1 h-1 z M2 5 h1 v1 h-1 z M5 5 h1 v1 h-1 z M3 6 h1 v1 h-1 z M4 6 h1 v1 h-1 z" fill="rgb(139,22,0)" /></svg>');
|
|
140
135
|
}
|
|
141
136
|
|
|
142
137
|
.nes-container.header {
|
|
@@ -185,18 +180,21 @@ footer {
|
|
|
185
180
|
.nes-container.downloads {
|
|
186
181
|
font-family: 'Press Start 2P', Helvetica, Arial, sans-serif;
|
|
187
182
|
background-color: #5adb57;
|
|
188
|
-
margin-top:
|
|
183
|
+
margin-top: 12px;
|
|
189
184
|
}
|
|
190
185
|
|
|
191
186
|
.nes-btn.is-file {
|
|
192
187
|
color: #fafafa;
|
|
193
188
|
background-color: #01b801;
|
|
189
|
+
}
|
|
190
|
+
.nes-btn.is-file::after {
|
|
194
191
|
box-shadow: inset -4px -4px #007800;
|
|
195
192
|
}
|
|
196
|
-
|
|
197
193
|
.nes-btn.is-file:hover {
|
|
198
194
|
background-color: #5adb57;
|
|
199
|
-
|
|
195
|
+
}
|
|
196
|
+
.nes-btn.is-file:hover::after {
|
|
197
|
+
box-shadow: inset -6px -6px #01b801;
|
|
200
198
|
}
|
|
201
199
|
|
|
202
200
|
.nes-list.is-disc li::before,
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: jekyll-theme-8bit
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.3.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Juliano Fernandes
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2019-
|
|
11
|
+
date: 2019-03-29 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: jekyll
|