Project

niebieski

0.0
No commit activity in last 3 years
No release in over 3 years
A minimal blue theme for Jekyll
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.12
~> 10.0

Runtime

 Project Readme

Niebieski

Niebieski it's the Polish word for the colour blue, which is the dominant colour in this minimal Jekyll theme.

Home Page View Home View

Installation

Add this line to your Jekyll site's Gemfile:

gem "Niebieski"

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

theme: Niebieski

And then execute:

$ bundle

Or install it yourself as:

$ gem install Niebieski

Usage

You can create Projects and Featured Posts by adding specific settings in the post front matter.

Projects

To create a Project you need to add the following:

categories: Projects
tag: < project category>
tag-icon:
image:

As you can see, any posts with the category Projects will be marked as a project and will be shown in the Projects area of the home page(limited to the latest 2 projects) and in the Projects page(all of the projects are shown).

A tag and a tag-icon can be used as a category in a normal post. This will only be shown on the home page. The tag-icon can be any HTML code (see the project example for more info)

Posts & Featured posts

Posts and featured posts are pretty much the same, they will just be shown in a different place on the blog page.

categories:
category_icon: 
tags: 

The category can be any that you like but they should match the ones specified in the _config.yml in order for the category icons to work without any issues.

Featured posts will show their category above the title on the blog page. You can specify a different icon to be shown before the category name.

In order for you to specify a featured post, all you need to do is add tags: Featured to the front matter.

Check the featured post example for more info about posts & featured posts.

The _config.yml file

Things you can specify in the file:

  • Specify 4 main categories for blog posts
  • Specify 4 icons for each category (used in the recent posts area)
  • Specify social media names to appear on the site
  • Specify google analytics id

In the _config.yml file you can specify 4 categories to use in the posts alongside with the icon of each category. This category icon is to be used on the home page in the Recent Posts area.

Resources

This theme was created with the following resources:

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/FabioRosado/Niebieski. 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.

Development

To set up your environment to develop this theme, run bundle install.

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.

License

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