Oinam Jekyll

A simple, clean, and minimal Jekyll Theme.

This is the demo and documentation for Oinam Jekyll Theme. The Styleguide has the demonstation of all content features and options you can use. I wrote an article about how and why I built this Jekyll Theme.

The source is hosted on Github and you can download a zipped version of the source code.


Installation

There are three ways of using Oinam Jekyll Theme;

  1. Remote Theme
  2. Template
  3. Ruby Gem

Remote Theme (Preferred)

Use oinam-jekyll as a remote theme and you should be good to go. Add remote_theme: oinam/oinam-jekyll in the _config.yml file.

This is the preferred option. You get updates as soon as a new feature is added or bugs are fixed and updated on Github. You also get the latest versions.

Template (Modify and Use)

Either fork the repository or Use this Template from the repository on Github.

This option is suggested for Jekyll tinkerers and experts who are willing to update manually.

Ruby Gem

The theme is also available as a Ruby Gem. This will be the least updated. Minor fixes and changes will NOT be reflected here quickly enough.


Layouts

  1. home layout where you can have content blurbs on the top and the last few recent posts.
  2. blog layout that lists the titles of the posts along with the years as the headings.
  3. page layout for pages.
  4. post layout for posts.

Configuration

The _config.yml has quite a few settings that are configurable. Removing the default Footer Credit and the Footer text are configurable. Choosing either Serif or Sans-Serif font-family, etc.

Color

There are three basic color themes included – default, nord, and vintage. Treat them as samples for you to make your own. If you are tinkering with the code, you will find it as easy as just changing few color (HEX) values in the CSS. If you want to pick one of the three, pick a choice in _config.yml.


Content

The Styleguide has examples and demos to treat images, videos, etc. with various layout and placement options.


Development

Plain simple Jekyll and nothing else. Get Jekyll running on your local system and run this;

$ bundle exec jekyll serve

Or enable drafts, future, and serve it incremental;

$ bundle exec jekyll serve --drafts --future --incremental


Contributing

You are welcome to contribute to the theme by sending in Pull Request with changes, edits, and fixes. Or, contribute by filing Bugs and Issues.

There is a server that runs a local development server for development;

$ ./server

it is just a script that runs;

$ bundle exec jekyll serve --config _config.yml,_config_dev.yml


License

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