Set up Eleventy
If you’re following along, you’ll need an Eleventy site running on your local machine. There are some excellent starter projects provided by the community which are helpful when getting started. In this post, I'll use Eleventy base blog as a starting point. Clone the repository and change into that directory:
git clone https://github.com/11ty/eleventy-base-blog.git my-blog-name
Inside the new project directory,
npm install dependencies and run
eleventy – this will compile the starter project locally into a new
_site directory. The
_site folder contains the static markup and assets which we'll deploy to Github Pages using Travis:
If the site built correctly, you should see something like the following in your terminal:
Writing _site/about/index.html from ./about/index.md.
Writing _site/tags/another-tag/index.html from ./tags.njk.
Writing _site/tags/number-2/index.html from ./tags.njk.
Copied 2 items and Processed 16 files in 0.34 seconds (21.3ms each, v0.9.0)
Set up Git
Next, we'll push the Eleventy project to a new repository on Github. I called mine
my-blog-name to match the name of my local project directory.
Once the repository is set up on Github, create a new repository locally and push the code.
# First, remove the existing Eleventy repo
rm -rf .git
# Next, create a new repo and push to Github
git add .
git commit -m "first commit"
git remote add origin https://github.com/[your git username]/my-blog-name.git
git push -u origin master
Now we'll set up Github Pages. Create a new branch called
gh-pages in Github, and enable Pages by going to Settings / Github Pages and selecting
gh-pages as the source branch.
We'll also need to create a new access token so Travis can push your site to the
gh-pages branch. In Settings / Developer Settings / Personal Access Tokens select "Generate new token." When prompted, provide a note for this key (e.g., Travis key) and grant access to your public repositories by checking
Next, select "Generate token." On the next page you will be able to see you new token. Copy / paste this to a safe place (you'll need this handy in the next step).
Set up Travis
If you don't have an account, sign up for one now on the Travis website. Follow the on-screen instructions to integrate Travis with your Github account. There will be several steps and you will be asked to grant permissions to Travis so it can access any repositories you want to build and deploy.
Once the setup process is complete, head back to Github and configure the Github Travis app. Scroll down to the Repositories section, and select your Eleventy repository (e.g.,
my-blog-name). Once this is complete, you'll be redirected back to Travis, where you'll see your repository listed under your account.
In the repository settings in Travis, you should add a new authentication key so that Travis can push to Githib. Paste in the GitHub key you created earlier, name it
This key will be populated by Travis when it reads the
travis.yml file in your Git repository. If you take a look at that file you'll see a property named
github-token, with the value
Let's take a quick look at the
travis.yml file now. I've set the path prefix to "/". I also set the build and deploy branches to
gh-pages, respectively. Here's what my finalised
travis.yml file looks like.
- npm install @11ty/eleventy -g
script: eleventy --pathprefix="/"
# Set in travis-ci.org dashboard
# Deploy branch
# Build branch
Now you can build and deploy. In Travis, select "Build Now”. Wait a moment for Travis to build and deploy. On completion, you should notice a success message in the console indicating that your site has been deployed.
One thing to bear in mind is Travis will conveniently deploy whatever you push to your
master branch. For development, I set up a
develop branch on Github, so that I only push/merge to
master when I want to trigger a deployment.
If you head back over to Github, you should see that Travis has populated the
gh-pages branch with the built site. You should also now be able to see your site live at
https://[your user name].github.com/my-blog-name.
I hope you've found this post useful. Please get in touch if you have any questions or comments. Thanks for reading.