/waahm7.github.io

Henry: Jekyll theme meant for a gorgeous reading experience and packed with features

Primary LanguageSCSSMIT LicenseMIT

Henry

Henry is a Jekyll theme with a gorgeous reading experience, chock-full of features. To find out more about all the features check out this blog post.

Getting Started

The easiest way to get up and running with a Jekyll blog using Henry is using the included Docker configuration file.

# 1. clone Henry
git clone git@github.com:kaushikgopal/henry-jekyll.git my_blog
# 2. cleanup script so unnecessary files are remoed
./start_new_blog.sh
# 3. spin up blog with docker
docker-compose up

You're good to go!

## on a Mac
http://0.0.0.0:4000/
## on Windows
http://localhost:4000/

You can setup new/existing blogs with Henry, with or without Docker. Feel free to refer to this setup guide for details.

Publishing guide

Github Pages

If you wish to publish your blog using Github Pages (a popular free hosting option) you can follow this publishing guide.

Firebase Hosting (included with Docker container)

Another good option to publish your blog is Firebase hosting. It includes a pretty generous free plan and allows plenty of customizability. Here's a setup guide.

Contributing

Bug reports and pull requests are welcome on GitHub. 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 get started check out the DEVELOPMENT page.

Henry in the Wild

Here are a couple of blogs that use Henry:

  1. Karthick Gopal's blog
  2. Kaushik Gopal's blog
  3. Nic Finn's blog (Github Pages)

License

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