jekyll-theme-8bit 0.7.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 +12 -112
  3. metadata +11 -15
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 9986b8664623a3162c8e60a5503810bed631688c2e386afb0ec5ced766fe0aec
4
- data.tar.gz: 760ba5a94d192bf7eb7ee713225456d26cbabf82e6100d1ec4131f1a5dc0cbf7
3
+ metadata.gz: ff024a95835f25d382c900bbb46b520640906be6b7714410c8ebbeac625b2a34
4
+ data.tar.gz: c62110c1340f2586d7930a085674ac011baf7913a032ec4bc56c9d29b4311f06
5
5
  SHA512:
6
- metadata.gz: add7e1e6c92c907e2427ca3a5c5ea19eb0fbe29f7838cc53939cec9861ecb64cd9f18165950fafa711083888c88bef48dc2a7429a86f5e4464169ef870378976
7
- data.tar.gz: f2c24e386db0b0cac7a336962bb509142c54051857560c740222ab4aef9b82f5a2c3bf78783be69a303a9c88a2b1eb35b0cd561dbaf5584606a045b5c93f2562
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
 
@@ -21,133 +21,33 @@ And add this line to your Jekyll site's `_config.yml`:
21
21
  ```yaml
22
22
  theme: jekyll-theme-8bit
23
23
  ```
24
+
24
25
  Or this, if you’re publishing your Jekyll site on GitHub Pages:
26
+
25
27
  ```yaml
26
28
  remote_theme: julianolf/jekyll-theme-8bit
27
29
  ```
28
30
 
29
31
  And then execute:
30
32
 
31
- $ bundle
32
-
33
- Or install it yourself as:
34
-
35
- $ gem install jekyll-theme-8bit
36
-
37
- ## Contents
38
-
39
- **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.
40
-
41
- ### Layouts
42
-
43
- Refers to files within the `_layouts` directory, that define the markup for your theme.
44
-
45
- - `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`.
46
- - `post.html` — The layout for your posts.
47
-
48
- ### Includes
49
-
50
- 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.
51
-
52
- - `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`.
53
- - `footer.html` — Defines the site's footer section.
54
- - `fork-me.html` — Shows a *"Fork me on GitHub"* link when using the theme on a project with GitHub Pages enabled.
55
- - `google-analytics.html` — Inserts Google Analytics module (active only in production environment).
56
- - `head.html` &mdash; Code-block that defines the `<head></head>` in _default_ layout.
57
- - `header.html` &mdash; Defines the site's main header section. By default, pages with a defined `title` attribute will have links displayed here.
58
- - `social.html` &mdash; Icons for social networks. Wich icons will be visible depends on what was defined in `_config.yml`.
59
-
60
- ### SASS
61
-
62
- Refers to `.scss` files within the `_sass` directory that define the theme's styles.
63
-
64
- - `fonts.scss` &mdash; Defines font faces used by 8bit's theme.
65
- - `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.
66
- - `rouge-github.scss` &mdash; Defines the styles for syntax-highlighting.
67
-
68
- ### Assets
69
-
70
- Refers to various asset files within the `assets` directory.
71
-
72
- - `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`.
73
- - `fonts/Press-Start-2P/` &mdash; The directory contains font files for *ttf*, *woff* and *woff2* formats.
74
- - `js/scale-fix.js` &mdash; Zooming scale fix for iPhone.
75
-
76
- 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.
77
-
78
- ### Plugins
79
-
80
- **jekyll-theme-8bit** comes with two plugins preinstalled.
81
-
82
- - [`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.
83
- - [`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.
84
-
85
- ## Usage
86
-
87
- ### Customization
88
-
89
- 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.
90
-
91
- So far 8bit theme specific customizations are only available through entries in `_config.yml`.
92
-
93
- #### Custom logo
94
-
95
- 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`.
96
-
97
- **PS**.: Nintendo owns the copyright of these characters. Please comply with the Nintendo guidelines and laws of the applicable jurisdiction.
98
-
99
- #### Showing download buttons
100
-
101
- 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`.
102
-
103
- #### Social networks
104
-
105
- 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.
106
-
107
- ```yaml
108
- # file: _config.yml
109
-
110
- social:
111
- twitter: https://twitter.com/username
112
- facebook: https://facebook.com/username
113
- github: https://github.com/username
114
- youtube: https://youtube.com/channel/ID
115
- google: https://plus.google.com/username
116
- medium: https://medium.com/@username
117
- twitch: https://twitch.com/username
118
- reddit: https://www.reddit.com/user/username
119
- whatsapp: tel:+5541999999999
120
- gmail: mailto:username@domain.net
121
- linkedin: https://www.linkedin.com/in/username
33
+ ```bash
34
+ bundle
122
35
  ```
36
+ Or install it yourself as:
123
37
 
124
- #### Comments
125
-
126
- 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.
127
-
128
- If you already have an account all you need to do is add the following entries to your `_config.yml`:
129
-
130
- ```yaml
131
- disqus:
132
- shortname: your-sites-shortname
38
+ ```bash
39
+ gem install jekyll-theme-8bit
133
40
  ```
134
41
 
135
- 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
136
43
 
137
- 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).
138
45
 
139
46
  ## Contributing
140
47
 
141
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.
142
49
 
143
- ## Development
144
-
145
- To set up your environment to develop this theme, run `bundle install`.
146
-
147
- 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.
148
-
149
- When your theme is released, only the files in `_layouts`, `_includes`, `_sass` and `assets` tracked with Git will be bundled.
150
- 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).
151
51
 
152
52
  ## License
153
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.7.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: 2023-07-22 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.4.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.4.0
31
+ version: 4.5.0
33
32
  - !ruby/object:Gem::Dependency
34
33
  name: jekyll-paginate
35
34
  requirement: !ruby/object:Gem::Requirement
@@ -78,14 +77,14 @@ dependencies:
78
77
  requirements:
79
78
  - - "~>"
80
79
  - !ruby/object:Gem::Version
81
- version: 1.8.1
80
+ version: 1.9.0
82
81
  type: :development
83
82
  prerelease: false
84
83
  version_requirements: !ruby/object:Gem::Requirement
85
84
  requirements:
86
85
  - - "~>"
87
86
  - !ruby/object:Gem::Version
88
- version: 1.8.1
87
+ version: 1.9.0
89
88
  - !ruby/object:Gem::Dependency
90
89
  name: html-proofer
91
90
  requirement: !ruby/object:Gem::Requirement
@@ -106,28 +105,28 @@ dependencies:
106
105
  requirements:
107
106
  - - "~>"
108
107
  - !ruby/object:Gem::Version
109
- version: 13.0.6
108
+ version: 13.3.0
110
109
  type: :development
111
110
  prerelease: false
112
111
  version_requirements: !ruby/object:Gem::Requirement
113
112
  requirements:
114
113
  - - "~>"
115
114
  - !ruby/object:Gem::Version
116
- version: 13.0.6
115
+ version: 13.3.0
117
116
  - !ruby/object:Gem::Dependency
118
117
  name: rubocop
119
118
  requirement: !ruby/object:Gem::Requirement
120
119
  requirements:
121
120
  - - "~>"
122
121
  - !ruby/object:Gem::Version
123
- version: 1.54.2
122
+ version: 1.55.1
124
123
  type: :development
125
124
  prerelease: false
126
125
  version_requirements: !ruby/object:Gem::Requirement
127
126
  requirements:
128
127
  - - "~>"
129
128
  - !ruby/object:Gem::Version
130
- version: 1.54.2
129
+ version: 1.55.1
131
130
  - !ruby/object:Gem::Dependency
132
131
  name: w3c_validators
133
132
  requirement: !ruby/object:Gem::Requirement
@@ -142,7 +141,6 @@ dependencies:
142
141
  - - "~>"
143
142
  - !ruby/object:Gem::Version
144
143
  version: 1.3.7
145
- description:
146
144
  email:
147
145
  - julianofernandes@gmail.com
148
146
  executables: []
@@ -174,7 +172,6 @@ homepage: https://github.com/julianolf/jekyll-theme-8bit
174
172
  licenses:
175
173
  - MIT
176
174
  metadata: {}
177
- post_install_message:
178
175
  rdoc_options: []
179
176
  require_paths:
180
177
  - lib
@@ -189,8 +186,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
189
186
  - !ruby/object:Gem::Version
190
187
  version: '0'
191
188
  requirements: []
192
- rubygems_version: 3.4.17
193
- signing_key:
189
+ rubygems_version: 3.6.7
194
190
  specification_version: 4
195
191
  summary: A Jekyll theme inspired by classic 8bit games.
196
192
  test_files: []