Edgio
Edgio

Eleventy

This guide shows you how to deploy a Eleventy application to Edgio.

Example

System Requirements

Sign up for Edgio

Deploying requires an account on Edgio. Sign up here for free.

Install the Edgio CLI

If you have not already done so, install the Edgio CLI.

With npm:

Bash
1npm i -g @edgio/cli

With yarn:

Bash
1yarn global add @edgio/cli

Create a new Eleventy app

If you don’t already have a Eleventy app, create one by running the following:

Bash
1npm install -g @11ty/eleventy
2
3mkdir project-name
4cd project-name
5
6echo '# Page header' > README.md

You can verify your app works by running it locally with:

Bash
1eleventy --serve

Configuring your Eleventy app for Edgio

Create a package.json at the root of your project with the following:

JavaScript
1{
2 "name": "eleventy",
3 "scripts": {
4 "build": "eleventy",
5 "deploy": "edgio deploy"
6 }
7}

Initialize your project

In the root directory of your project run edgio init:

Bash
1edgio init

This will automatically update your package.json and add all of the required Edgio dependencies and files to your project. These include:

  • The @edgio/core package - Allows you to declare routes and deploy your application on Edgio
  • The @edgio/prefetch package - Allows you to configure a service worker to prefetch and cache pages to improve browsing speed
  • edgio.config.js - A configuration file for Edgio
  • routes.js - A default routes file that sends all requests to Eleventy.

Configure the routes

Update routes.js at the root of your project to the following:

JavaScript
1// This file was added by edgio init.
2// You should commit this file to source control.
3
4import {Router} from '@edgio/core/router';
5
6export default new Router()
7 // Prevent search engine bot(s) from indexing
8 // Read more on: https://docs.edg.io/guides/cookbook#blocking-search-engine-crawlers
9 .noIndexPermalink()
10 // Create serveStatic route for each file in the folder _site with a cache-control header of 's-maxage=315360000'
11 .static('_site')

Refer to the CDN-as-code guide for the full syntax of the routes.js file and how to configure it for your use case.

Run the Eleventy app locally on Edgio

Create a production build of your app by running the following in your project’s root directory:

Bash
1npm run build

Test your app with the Sites on your local machine by running the following command in your project’s root directory:

Bash
1edgio dev

Load the site http://127.0.0.1:3000

Deploying

Create a production build of your app by running the following in your project’s root directory:

Bash
1npm run build

Deploy your app to the Sites by running the following command in your project’s root directory:

Bash
1edgio deploy

Refer to the Deployments guide for more information on the deploy command and its options.