How you install DeepDive depends on whether you start a new site, or change the theme of an existing site.

  1. New sites
    1. Troubleshooting
  2. GitHub Pages
  3. Running locally

New sites

For new sites, the best way to get started with DeepDive is via the Starter Kit. It comes with a documented config file and example content that gets you started quickly.

If you have a GitHub account, fork the DeepDive Starter Kit repository. Otherwise download the Starter Kit and unzip them somewhere on your machine.

In addition to the docs here, you can follow the quick start guide in the Starter Kit.

You can now jump to running locally.

You can now also Deploy to Netlify directly.


If your existing site combines theme files with your content, make sure to delete the following folders:

  • _layouts
  • _includes
  • _sass
  • assets

The assets folder most likely includes theme files as well as your personal/content files. Make sure to only delete files that belong to the old theme!

GitHub Pages

If you want to build your site on GitHub Pages, check out the gh-pages branch in the DeepDive Starter Kit repo.

For existing sites, you can instead set the remote_theme key as follows:

# file: `_config.yml`
remote_theme: hydecorp/deepdive@v9.1.6

Make sure the plugins list contains jekyll-include-cache (create if it doesn’t exist):

# file: `_config.yml`
  - jekyll-include-cache

To run this configuration locally, make sure the following is part of your Gemfile:

# file: `Gemfile`
gem "github-pages", group: :jekyll_plugins
gem "jekyll-include-cache", group: :jekyll_plugins

Note that DeepDive has a reduced feature set when built on GitHub Pages. Specifically, using KaTeX math formulas doesn’t work when built in this way.

Running locally

Make sure you’ve cded into the directory where _config.yml is located. Before running for the first time, dependencies need to be fetched from RubyGems:

bundle install

If you are missing the bundle command, you can install Bundler by running gem install bundler.

Now you can run Jekyll on your local machine:

bundle exec jekyll serve

and point your browser to http://localhost:4000 to see DeepDive in action.

Continue with Config