Deneb Jekyll documentation

Deploy

Put your Deneb site online with Netlify, Cloudflare Pages or GitHub Pages, or upload the built folder to any host.

Before you go live, check this list:

  • url in _config.yml is your real address, with no slash at the end.
  • baseurl is empty, unless the site lives in a sub-folder.
  • The form is connected. See Contact form.
  • You have replaced the demo details, privacy.md and the sample content.
  • You have removed style-guide.html if you do not want that page.

Any web host

Build the site and upload the contents of _site/:

JEKYLL_ENV=production bundle exec jekyll build

On Windows PowerShell use two commands:

$env:JEKYLL_ENV="production"
bundle exec jekyll build

Netlify

  1. Put your site in a Git repository (GitHub, GitLab or Bitbucket).
  2. In Netlify, choose Add new site, Import an existing project and pick the repository.
  3. Use these settings:
Setting Value
Build command jekyll build
Publish directory _site
  1. If the build uses the wrong Ruby, add an environment variable RUBY_VERSION with a version of 3.1 or newer, such as 3.3.4. Add JEKYLL_ENV with the value production.

Cloudflare Pages

  1. Put your site in a GitHub or GitLab repository.
  2. In Cloudflare, open Workers & Pages, create a Pages project and connect the repository.
  3. Use these settings:
Setting Value
Build command jekyll build
Build output directory _site
  1. If you need a different Ruby, add an environment variable RUBY_VERSION, such as 3.3.4. Add JEKYLL_ENV with the value production.

GitHub Pages

GitHub Pages’ own build does not support jekyll-paginate-v2 or jekyll-archives, and Deneb needs both for the blog pages and tag pages. So publish with a GitHub Actions workflow instead. It builds the site with your own Gemfile, then uploads the result.

  1. Put your site in a GitHub repository.
  2. In the repository, open Settings, Pages. Under Build and deployment, set Source to GitHub Actions.
  3. Create the file .github/workflows/pages.yml:
name: Deploy to GitHub Pages

on:
  push:
    branches: [main]
  workflow_dispatch:

permissions:
  contents: read
  pages: write
  id-token: write

concurrency:
  group: pages
  cancel-in-progress: false

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: ruby/setup-ruby@v1
        with:
          ruby-version: "3.3"
          bundler-cache: true
      - id: pages
        uses: actions/configure-pages@v5
      - name: Build
        run: bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}"
        env:
          JEKYLL_ENV: production
      - uses: actions/upload-pages-artifact@v3

  deploy:
    needs: build
    runs-on: ubuntu-latest
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - id: deployment
        uses: actions/deploy-pages@v4
  1. Commit and push to main. Open the Actions tab to watch the build. The address shows when it finishes.

The workflow sets baseurl for you from your Pages settings. For username.github.io or a custom domain it is empty. For a project site it is /repository-name.

If the build fails because the Gemfile.lock was made on Windows or macOS, run this on your computer, then commit the changed file:

bundle lock --add-platform x86_64-linux

Your own domain

Add the domain in your host’s settings (Netlify, Cloudflare Pages or GitHub Settings, Pages, Custom domain), then add the DNS record the host asks for. Set url in _config.yml to the new address.

After you launch

Your site makes /sitemap.xml and /feed.xml for you. Submit the sitemap in Google Search Console.