Deneb Jekyll documentation

Updating

How to move from Deneb 1 or 2 to 3.0, and how to take future updates without losing your changes.

From version 1 or 2 to 3.0

Version 3.0 is a full rebuild. The design, the page templates and the settings files are all new, so you cannot copy the new files over an old site. Start a new site from the 3.0 download and move your content into it.

  1. Unzip Deneb 3.0 into a new folder and run it. See Install.
  2. Move your site details into the deneb: block of _config.yml. The old _data/settings.yml is no longer used. See Configuration.
  3. Rebuild your menu in _data/navigation.yml. The format is new: each item has title and url. See Navigation.
  4. Move your services into _services/, your projects into _portfolio/, your posts into _posts/ and your authors into _authors/. Use the front matter shown in Services and portfolio and Blog. Keep the post file names, so the post addresses stay the same.
  5. Rebuild your pages from sections. See Pages and sections. Move testimonials, team members, FAQ, prices, stats and client names into the files in _data/.
  6. Copy your pictures into assets/img/. Use WebP.
  7. Move your own CSS into assets/css/custom.css. See below.
  8. Check the addresses. Post addresses are /blog/<title>/ and service and project addresses are /services/<name>/ and /portfolio/<name>/. If an address was different on your old site, change the permalink settings so it stays the same, or set up redirects at your host.

Open the old site and the new one side by side, and compare every page before you switch.

Your own CSS

Put all your CSS changes in assets/css/custom.css. Never edit assets/css/deneb.css or deneb.rtl.css: they are rebuilt from the theme source, and a future update replaces them.

Old CSS that targeted version 2 class names will not work, because the markup is new. Use the tokens in Colours and fonts instead.

Future updates

When a new version is released, you get it as a new download. To take one:

  1. Keep a copy of your site (use Git, or copy the folder).
  2. Unzip the new download in a separate folder.
  3. Compare it to your site with a diff tool. Copy over changes in _layouts/, _includes/, assets/css/deneb.css, assets/css/deneb.rtl.css, assets/js/ and Gemfile.
  4. Do not copy over your own files: _config.yml, _data/, the content folders, the pages and assets/css/custom.css. If the new version adds a key to _config.yml or a key to _data/i18n.yml, add it to your own copy.
  5. Run bundle install and bundle exec jekyll serve, and check the site.

The more you keep to custom.css, the easier updates are. If you edit a layout or an include, note it down so you can repeat the change.

Check the Gemfile

After an update, run bundle install. Run bundle update only when you want newer plugin versions.