Install Theme In A Jekyll Project

WARNING! This theme hasn’t been published as a Gem yet, so while these instructions should be correct once it has been published, currently it won’t work.

You can add this port of the Read The Docs theme to your Jekyll project as you would normally do with any other gem-based Jekyll theme.

There are two simple methods to do this:

  1. Editing your project Gemfile
  2. Manually installing the gem

Edit your project Gemfile

Add this line to your Jekyll site’s Gemfile:

gem "jekyll-theme-rtd"

Add this line to your Jekyll site’s _config.yml:

theme: jekyll-theme-rtd

And then execute:

$ bundle

Manually install gem

Or install the gem yourself with:

$ gem install jekyll-theme-rtd

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

theme: jekyll-theme-rtd

Local Jekyll to test GH Pages

If you are hosting your website in GH Pages, but testing locally with Jekyll you might want to have a look at the official documentation for Testing your GitHub Pages site locally with Jekyll.