Web output

• Using GitHub Pages

Run the template’s run- script for your operating system and follow the prompts. For these to work, you must already have Jekyll installed and working.

• On Windows, run run-windows.bat by double-clicking it from your file explorer.
• On Linux, run run-linux.sh. You may have to run it from a terminal, and first enter chmod +x run-linux.sh to give it permissions, then ./run-linux.sh.
• On Mac OSX, double-click run-mac.command in Finder. You may need to give the file permission to run first. To do this, in a Terminal in the same folder as the script, type chmod +x run-mac.command.

Using GitHub Pages

If you activate GitHub Pages in your repository settings on GitHub.com, GitHub will host your built site for free. GitHub will assign the site a URL by default that looks like username.github.io/reponame. You can then set up a custom domain name by pointing your own domain at GitHub’s servers, and putting a CNAME file containing that domain name in your project’s root directory.

See GitHub’s help docs for guidance on how to do this.

In your Electric Book project, you must update the baseurl in _config.yml for this to work.

• If you are using a custom domain, the baseurl should be empty: baseurl: ""
• If you are using the username.github.io/reponame URL that GitHub provides automatically, you must set the baseurl to the name of your repo, with a slash in front of it. E.g.: baseurl: "/superpotatoes".

This is because your site is being served at a subdirectory-like URL, and all links in your book must be relative to that full URL. For instance, it must know that your website’s CSS is at farmerjane.github.io/superpotatoes/book/styles/web.css, and not farmerjane.github.io/book/styles/web.css.