Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Deployment

Publish your site for free using GitHub Pages.

First-time deployment

Step 1: Deploy

From your project folder:

bundle exec rake deploy

This builds your site and pushes it to a gh-pages branch.

Step 2: Configure GitHub Pages

  1. Go to your repository on GitHub
  2. Click Settings (top menu)
  3. Click Pages (left sidebar)
  4. Under Source, select Deploy from a branch
  5. Select gh-pages branch and / (root)
  6. Click Save

See Configuring a publishing source for more details.

Step 3: Wait for deployment

GitHub will build and deploy your site. This takes 2-5 minutes.

Your site will be available at:

SetupURL
Organisationhttps://acm-cre-university.github.io
Personal accounthttps://username.github.io/acm-cre-university

Updating your site

After making changes locally:

  1. Test locally with bundle exec jekyll serve
  2. When ready, run bundle exec rake deploy

Changes go live in a few minutes.

Next steps

Having issues?

See the Troubleshooting guide for solutions to common deployment problems.