julianolf / jekyll-theme-8bit Goto Github PK

View Code? Open in Web Editor NEW

29.0 2.0 12.0 129 KB

👾 A Jekyll theme inspired by classic 8bit games.

Home Page: https://julianolf.github.io/jekyll-theme-8bit/

License: MIT License

Ruby 16.77% HTML 26.28% JavaScript 4.39% SCSS 52.56%

jekyll theme jekyll-theme github-pages retro game 8bit pixel-art

jekyll-theme-8bit's Introduction

jekyll-theme-8bit

A Jekyll theme inspired by classic 8bit games.

Preview

You can see how the theme looks like here.

Installation

Add this line to your Jekyll site's Gemfile:

gem "jekyll-theme-8bit"

And add this line to your Jekyll site's _config.yml:

theme: jekyll-theme-8bit

Or this, if you’re publishing your Jekyll site on GitHub Pages:

remote_theme: julianolf/jekyll-theme-8bit

And then execute:

bundle

Or install it yourself as:

gem install jekyll-theme-8bit

Customization

Detailed instructions can be found at the wiki pages.

Contributing

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 code of conduct.

Instructions for local development are available at the wiki pages.

License

The theme is available as open source under the terms of the MIT License.

Credits

8bit style by NES.css

jekyll-theme-8bit's People

Contributors

Stargazers

Watchers

Forkers

lanius-shrike legkvla robterrell jahdebe leandroalemao elky84 jcrunjie jdodinh mroberts1 anshu957 dovask pearls-lab

jekyll-theme-8bit's Issues

Dark mode

Add an alternative set of colours based on a dark background. This two theme modes can be switched by setting a variable in _config.yml like theme_mode: [light or dark] with light being the default value.

Support NES.css 2.1.1

Apply necessary changes to support version 2.1.1 of NES.css library.

Improve README

Improve readme file by adding more detailed information.

Add Contents: describe what is included in the theme.
Add Usage: describe how use and customize the theme, variables available, etc.
Add Credits: list contributions, used tools, libraries, etc.

Missing kramdown-parser-gfm

Local install fails due to missing gem kramdown-parser-gfm, even after installing the gem. Kramdown 2.4.0 is also installed.

Tried with 3 versions of Ruby: 2.7.8, 3.1.4, 3.2.2.

Forking to github page doesn't create

Forking this repo to a github page doesn't seem to bundle the theme.

Support to comments

Add support to comments for posts.

It can be done by integrating to Disqus. The minima theme has it implemented and can be used as a start point for learning on how to do it.

Update NES.css version

The project is currently using the version 2.0.0 of NES.css library and it would be nice to update to the version 2.3.0.

Theme compatibility with later versions of Jekyll

Hello!

I was attempting to apply this theme locally. I'm using Jelkyll version 4.3.2 and it appears that this theme is only compatible with versions of Jekyll <= 4.2.x. If there's a straghtforward way for me assist in making it compatible with later versions of Jekyll, I'm happy to help.

Thanks in advance!

EDITED TO ADD: It looks like there are some dependabot dependency PRs to the Gemspec that if merged could do the trick. Happy to help in whatever way possible with this, since I like this theme so much.

SASS code refactoring needed

Review and rewrite _sass/jekyll-theme-8bit.scss source code in order to be more SASS than pure CSS allowing the reuse of this file as a code base to more specific styling.

e.g.:

Separate layout rules and style.
Make use of variables for colours, sizes, etc.
Avoid repetition by using inheritance.

Update Jekyll version to 4.0.0

$ bundle update

Fetching gem metadata from https://rubygems.org/...........
Fetching gem metadata from https://rubygems.org/.
Resolving dependencies...
Bundler could not find compatible versions for gem "jekyll":
  In Gemfile:
    jekyll (~> 4.0.0)

    jekyll-theme-8bit was resolved to 0.3.0, which depends on
      jekyll (~> 3.8.5)

Better preview page

Create a better preview page, maybe an initial page explaining what the project is about, what is included, some image preview and making use of different markup elements to show how the theme is suppose to look like. A link to a blog page could be added pointing to what is currently the initial page.

Move index.html to a new directory /blog.
Set the variable paginate_path: '/blog/page:num/'.
Create a new index.html in project's root directory.