HANUMAN Jekyll Theme

Hanuman is a minimal yet powerful Jekyll theme for your blogs and websites.

It is built using the open source AMP Start framework and can be customized as per your requirements.

Features

  • Minimal
  • Responsive
  • Syntax Highlighting for code
  • Cover Images for homepage and blog posts
  • Social Sharing
  • Simple Navigation Menu
  • Pagination
  • Google Analytics
  • Can be easily installed via "theme gem"
  • Github Pages support
  • Easily Customisable

Installation

There are different ways to install the theme -

1. Cloning the repository and updating settings

  1. Fork this repository and clone the forked repository.
  2. Update the _config.yml file as per your requirements.
  3. Add your posts to the _posts directory.
  4. Deploy to Github Pages or your own server.

Deploying to Github Pages

There are 2 methods you can use to deploy the site to Github Pages -

  1. Run bundle exec jekyll serve inside your cloned repository. Push the contents of the resulting _site to your Github Pages repository.

  2. Using Travis CI

  3. Set up travis-ci for your fork.

  4. Generate your secure token with the travis gem: Run gem install travis on your terminal.

  5. Grab the GH_TOKEN from https://github.com/settings/tokens

  6. Then run travis encrypt 'GIT_NAME="YOUR_USERNAME" GIT_EMAIL="YOUR_EMAIL" GH_TOKEN=YOUR_TOKEN'

  7. Add the token to your .travis.yml file.

Now you just need to push the files. Travis will generate the HTML files and automatically push them to your gh-pages branch. This is the setup I am using.

2. Ruby Gem Method

Add this line to your Jekyll site's Gemfile:

gem "hanuman"

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

theme: hanuman

And then execute:

$ bundle

Or install it yourself as:

$ gem install hanuman

Usage

TODO: Write usage instructions here. Describe your available layouts, includes, sass and/or assets.

Contributing

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

To submit a pull request -

  1. Fork/clone the repository.
  2. Develop.
  3. Create a new branch from the master branch.
  4. Open a pull request on Github describing what was fixed or added.

License

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