samirparhi-dev / bajawa

Bajawa is a jekyll theme starter. Built for those who likes simple and clean blog.

Bajawa Jekyll Theme

Welcome to Bajawa! A simple and clean Jekyll theme with a little touch of pastel colors! In this readme, you'll find the documentations you need to be able to set up this theme into jekyll.

Bajawa could be used as a starter also. Customize and tweak it with your own style.

Bajawa theme information:

Author: Cynthia Ayu W.
Repository: https://github.com/kulacino/bajawa
Version: 0.1.0
Gem: 0.1.0

If you like and enjoy this theme, please consider treating me a coffee so I could develop and maintain it regularly.

Table of Contents

1. Installation
   1. Ruby Gem Method
   2. GitHub Pages Method
      1. Exclude Something
2. Site Settings
   1. Structure
   2. Configuration
3. Layouts
   1. layout: default
   2. layout: post
   3. layout: page
   4. layout: home
   5. layout: search
4. Navigation
5. Author
6. Footer
   1. Footer Social
   2. Copyright Text
7. Font Awesome Icons
8. Contributing
9. Development
10. Attribution
11. License

Installation

Ruby Gem Method

Add this line to your Jekyll site's Gemfile:

gem "bajawa"

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

theme: bajawa

And then execute:

$ bundle

Or install it yourself as:

$ gem install bajawa

Github Pages Method

to be added

Exclude Something

to be added

Site Settings

to be added

Structure

Basic jekyll layout on first initialization.

Configuration

Bajawa calls every configuration from _config.yml.

Layouts

lorem ipsum dolor

layout: default

to be added

layout: post

to be added

layout: page

to be added

layout: home

to be added

layout: search

to be added

Navigation

to be added

Author

to be added

Footer

to be added

Footer Social

to be added

Copyright Text

to be added

Font Awesome Icons

Bajawa comes with font awesome icons. Font awesome css is linked as external stylesheet via its CDN. Open _includes/head.html file and then scroll down before </head>.

<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css">

If you want to host it by yourself, download font-awesome.min.css from here.

Place it under assets/css/font-awesome.min.css and call it via link rel above.

Contributing

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

When your theme is released, only the files in _layouts, _includes, _sass and assets tracked with Git will be bundled. To add a custom directory to your theme-gem, please edit the regexp in bajawa.gemspec accordingly.

Attribution

Below is attributions and credits to external sources, such as: image, code, script, etc.

• Hero Image captured by Carolyn V downloaded via Unsplash
• Test Image captured by Billy Cox downloaded via Unsplash
• Search Page using lunr.js

License

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