Deneb Jekyll documentation

Install

Install Ruby and Bundler on Windows, macOS or Linux, then run Deneb on your computer.

Deneb needs Ruby 3.1 or newer and Bundler. Jekyll itself is installed for you by Bundler.

Install Ruby

Windows. Download the Ruby+Devkit installer from rubyinstaller.org. Run it and accept the defaults. At the end, let it run ridk install and press Enter to choose the default option.

macOS. The Ruby that comes with macOS is too old. Install Homebrew, then run:

brew install ruby

Follow the note Homebrew prints at the end, which adds Ruby to your PATH.

Linux (Debian or Ubuntu).

sudo apt install ruby-full build-essential zlib1g-dev

Other systems: see the Ruby installation guide.

Check it worked. Open a new terminal and run:

ruby -v

Install Bundler

gem install bundler

Run the theme

Unzip the download and open a terminal in the folder that holds _config.yml. Then:

bundle install
bundle exec jekyll serve

Open http://localhost:4000.

The first bundle install downloads Jekyll and its plugins. The Gemfile lists them: jekyll, jekyll-seo-tag, jekyll-sitemap, jekyll-feed, jekyll-paginate-v2 and jekyll-archives. It also lists csv, base64, bigdecimal, logger and webrick, which Ruby 3.4 no longer bundles.

Build the site

bundle exec jekyll build

The finished site is in the _site folder. Add JEKYLL_ENV=production in front of the command for the live version. See Deploy.

Common problems

  • bundle install fails on Windows. Run ridk install again and choose the default option, then open a new terminal.
  • cannot load such file -- webrick. Run bundle install again. The Gemfile already includes it.
  • The browser shows an old page. Stop the server, run bundle exec jekyll clean, and start it again.
  • Port 4000 is taken. Run bundle exec jekyll serve --port 4001.