jekyll-theme-8bit 0.6.0 → 0.7.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 (3) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +14 -110
  3. metadata +32 -22
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 71fb42d90f425d2d8f7cfab6f5772133c1d28037b2381d4e8e37f615cdc874fa
4
- data.tar.gz: bc86f1617c2fdd1e4bf89d0f51942affb26402d3152c9d3cc2727392e50580dc
3
+ metadata.gz: ff024a95835f25d382c900bbb46b520640906be6b7714410c8ebbeac625b2a34
4
+ data.tar.gz: c62110c1340f2586d7930a085674ac011baf7913a032ec4bc56c9d29b4311f06
5
5
  SHA512:
6
- metadata.gz: 7afcace661a786417775299bb27db5e2f15b1eb2c0d2850e00f7c780f81bac45194335593335274b9a08c523e211bbb01121cb86cd21dfffc096a7802cceb816
7
- data.tar.gz: 90ade060cb8ded43cfca1e2c2086f84bece1838a028a3d8f971ac560b6fb1e067058dcf7c3e80663282fbc69f001d8e9bc9195d3c18941fe78b1a7aa343aff1c
6
+ metadata.gz: 752167100e55c6a8903308f1834b1daf790ecebb17f3d5d5f589234ef971635e6582a2e91f2dea183332c9f21d8d0d95da875269b23ba8791b3747fe7c5ff405
7
+ data.tar.gz: 1fc86896375b37f6a0478d1bb12c1ed3132b0d1d57291c013350a789bd656e7818efdc315bd5c336933bb05c703f9d60ebd0648876ebac34b0b0bb2820fba8b1
data/README.md CHANGED
@@ -1,12 +1,12 @@
1
1
  # jekyll-theme-8bit
2
2
 
3
- [![Build Status](https://travis-ci.org/julianolf/jekyll-theme-8bit.svg?branch=master)](https://travis-ci.org/julianolf/jekyll-theme-8bit) [![Gem Version](https://badge.fury.io/rb/jekyll-theme-8bit.svg)](https://badge.fury.io/rb/jekyll-theme-8bit)
3
+ [![Gem Version](https://badge.fury.io/rb/jekyll-theme-8bit.svg)](https://badge.fury.io/rb/jekyll-theme-8bit)
4
4
 
5
5
  A Jekyll theme inspired by classic 8bit games.
6
6
 
7
7
  ## Preview
8
8
 
9
- You can see how the theme looks like [here](http://julianofernandes.com.br/jekyll-theme-8bit/).
9
+ You can see how the theme looks like [here](https://julianolf.github.io/jekyll-theme-8bit/).
10
10
 
11
11
  ## Installation
12
12
 
@@ -22,128 +22,32 @@ And add this line to your Jekyll site's `_config.yml`:
22
22
  theme: jekyll-theme-8bit
23
23
  ```
24
24
 
25
- And then execute:
26
-
27
- $ bundle
28
-
29
- Or install it yourself as:
30
-
31
- $ gem install jekyll-theme-8bit
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` &mdash; Code-block that defines the `<head></head>` in _default_ layout.
53
- - `header.html` &mdash; Defines the site's main header section. By default, pages with a defined `title` attribute will have links displayed here.
54
- - `social.html` &mdash; 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` &mdash; Defines font faces used by 8bit's theme.
61
- - `jekyll-theme-8bit.scss` &mdash; 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` &mdash; 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` &mdash; 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/` &mdash; The directory contains font files for *ttf*, *woff* and *woff2* formats.
70
- - `js/scale-fix.js` &mdash; 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/) &mdash; 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) &mdash; 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
-
81
- ## Usage
82
-
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
- #### Showing 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.
25
+ Or this, if you’re publishing your Jekyll site on GitHub Pages:
102
26
 
103
27
  ```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
28
+ remote_theme: julianolf/jekyll-theme-8bit
118
29
  ```
119
30
 
120
- #### Comments
121
-
122
- Comments feature is provided by an integration between Jekyll and Disqus, so if you want to have a comments section below each post you will need a Disqus account.
31
+ And then execute:
123
32
 
124
- If you already have an account all you need to do is add the following entries to your `_config.yml`:
33
+ ```bash
34
+ bundle
35
+ ```
36
+ Or install it yourself as:
125
37
 
126
- ```yaml
127
- disqus:
128
- shortname: your-sites-shortname
38
+ ```bash
39
+ gem install jekyll-theme-8bit
129
40
  ```
130
41
 
131
- In case you still don't have an account take a look at [Disqus](https://disqus.com)' page for details on how to create and configure an account.
42
+ ## Customization
132
43
 
133
- Comments are enabled by default but if you want to disable them for one particular post you can by just adding `comments: false` to the post's YAML Front Matter.
44
+ Detailed instructions can be found at the [wiki pages](https://github.com/julianolf/jekyll-theme-8bit/wiki).
134
45
 
135
46
  ## Contributing
136
47
 
137
48
  Bug reports and pull requests are welcome. 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.
138
49
 
139
- ## Development
140
-
141
- To set up your environment to develop this theme, run `bundle install`.
142
-
143
- 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.
144
-
145
- When your theme is released, only the files in `_layouts`, `_includes`, `_sass` and `assets` tracked with Git will be bundled.
146
- To add a custom directory to your theme-gem, please edit the regexp in `jekyll-theme-8bit.gemspec` accordingly.
50
+ Instructions for local development are available at the [wiki pages](https://github.com/julianolf/jekyll-theme-8bit/wiki).
147
51
 
148
52
  ## License
149
53
 
metadata CHANGED
@@ -1,14 +1,13 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: jekyll-theme-8bit
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.6.0
4
+ version: 0.7.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Juliano Fernandes
8
- autorequire:
9
8
  bindir: bin
10
9
  cert_chain: []
11
- date: 2020-12-19 00:00:00.000000000 Z
10
+ date: 1980-01-02 00:00:00.000000000 Z
12
11
  dependencies:
13
12
  - !ruby/object:Gem::Dependency
14
13
  name: jekyll
@@ -19,7 +18,7 @@ dependencies:
19
18
  version: 3.8.5
20
19
  - - "<"
21
20
  - !ruby/object:Gem::Version
22
- version: 4.2.0
21
+ version: 4.5.0
23
22
  type: :runtime
24
23
  prerelease: false
25
24
  version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +28,7 @@ dependencies:
29
28
  version: 3.8.5
30
29
  - - "<"
31
30
  - !ruby/object:Gem::Version
32
- version: 4.2.0
31
+ version: 4.5.0
33
32
  - !ruby/object:Gem::Dependency
34
33
  name: jekyll-paginate
35
34
  requirement: !ruby/object:Gem::Requirement
@@ -50,85 +49,98 @@ dependencies:
50
49
  requirements:
51
50
  - - "~>"
52
51
  - !ruby/object:Gem::Version
53
- version: '2.5'
52
+ version: 2.8.0
54
53
  type: :runtime
55
54
  prerelease: false
56
55
  version_requirements: !ruby/object:Gem::Requirement
57
56
  requirements:
58
57
  - - "~>"
59
58
  - !ruby/object:Gem::Version
60
- version: '2.5'
59
+ version: 2.8.0
61
60
  - !ruby/object:Gem::Dependency
62
- name: bundler
61
+ name: kramdown-parser-gfm
63
62
  requirement: !ruby/object:Gem::Requirement
64
63
  requirements:
65
64
  - - "~>"
66
65
  - !ruby/object:Gem::Version
67
- version: 2.2.0
66
+ version: 1.1.0
67
+ type: :development
68
+ prerelease: false
69
+ version_requirements: !ruby/object:Gem::Requirement
70
+ requirements:
71
+ - - "~>"
72
+ - !ruby/object:Gem::Version
73
+ version: 1.1.0
74
+ - !ruby/object:Gem::Dependency
75
+ name: webrick
76
+ requirement: !ruby/object:Gem::Requirement
77
+ requirements:
78
+ - - "~>"
79
+ - !ruby/object:Gem::Version
80
+ version: 1.9.0
68
81
  type: :development
69
82
  prerelease: false
70
83
  version_requirements: !ruby/object:Gem::Requirement
71
84
  requirements:
72
85
  - - "~>"
73
86
  - !ruby/object:Gem::Version
74
- version: 2.2.0
87
+ version: 1.9.0
75
88
  - !ruby/object:Gem::Dependency
76
89
  name: html-proofer
77
90
  requirement: !ruby/object:Gem::Requirement
78
91
  requirements:
79
92
  - - "~>"
80
93
  - !ruby/object:Gem::Version
81
- version: '3.10'
94
+ version: 5.0.7
82
95
  type: :development
83
96
  prerelease: false
84
97
  version_requirements: !ruby/object:Gem::Requirement
85
98
  requirements:
86
99
  - - "~>"
87
100
  - !ruby/object:Gem::Version
88
- version: '3.10'
101
+ version: 5.0.7
89
102
  - !ruby/object:Gem::Dependency
90
103
  name: rake
91
104
  requirement: !ruby/object:Gem::Requirement
92
105
  requirements:
93
106
  - - "~>"
94
107
  - !ruby/object:Gem::Version
95
- version: 13.0.0
108
+ version: 13.3.0
96
109
  type: :development
97
110
  prerelease: false
98
111
  version_requirements: !ruby/object:Gem::Requirement
99
112
  requirements:
100
113
  - - "~>"
101
114
  - !ruby/object:Gem::Version
102
- version: 13.0.0
115
+ version: 13.3.0
103
116
  - !ruby/object:Gem::Dependency
104
117
  name: rubocop
105
118
  requirement: !ruby/object:Gem::Requirement
106
119
  requirements:
107
120
  - - "~>"
108
121
  - !ruby/object:Gem::Version
109
- version: '1.6'
122
+ version: 1.55.1
110
123
  type: :development
111
124
  prerelease: false
112
125
  version_requirements: !ruby/object:Gem::Requirement
113
126
  requirements:
114
127
  - - "~>"
115
128
  - !ruby/object:Gem::Version
116
- version: '1.6'
129
+ version: 1.55.1
117
130
  - !ruby/object:Gem::Dependency
118
131
  name: w3c_validators
119
132
  requirement: !ruby/object:Gem::Requirement
120
133
  requirements:
121
134
  - - "~>"
122
135
  - !ruby/object:Gem::Version
123
- version: 1.3.4
136
+ version: 1.3.7
124
137
  type: :development
125
138
  prerelease: false
126
139
  version_requirements: !ruby/object:Gem::Requirement
127
140
  requirements:
128
141
  - - "~>"
129
142
  - !ruby/object:Gem::Version
130
- version: 1.3.4
131
- description:
143
+ version: 1.3.7
132
144
  email:
133
145
  - julianofernandes@gmail.com
134
146
  executables: []
@@ -160,7 +172,6 @@ homepage: https://github.com/julianolf/jekyll-theme-8bit
160
172
  licenses:
161
173
  - MIT
162
174
  metadata: {}
163
- post_install_message:
164
175
  rdoc_options: []
165
176
  require_paths:
166
177
  - lib
@@ -175,8 +186,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
175
186
  - !ruby/object:Gem::Version
176
187
  version: '0'
177
188
  requirements: []
178
- rubygems_version: 3.1.4
179
- signing_key:
189
+ rubygems_version: 3.6.7
180
190
  specification_version: 4
181
191
  summary: A Jekyll theme inspired by classic 8bit games.
182
192
  test_files: []