VuePress

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

Before proceeding, you will need an Edgio property. Create one now if you do not already have one.

System Requirements

Install Node.js 14.x

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.

Bash
npm i -g @edgio/cli@^5.0.0

Create a new VuePress app

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

Bash
yarn create vuepress-site [optionalDirectoryName]
cd docs # The root directory of your project
yarn install

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

1yarn dev

Configuring your VuePress app for Edgio

Update package.json

JSON
"build": "vuepress build src",
"build": "vuepress build src -d=public",

Initialize your project

In the root directory of your project run edgio init:

1edgio init --edgioVersion ^5.0.0

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 VuePress.

Configure the routes

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

JavaScript
// This file was added by edgio init.
// You should commit this file to source control.

import {Router} from '@edgio/core/router';

export default new Router()
  // Create serveStatic route for each file in the folder public with a cache-control header of 's-maxage=315360000'
  .static('public');

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 VuePress app locally on Edgio

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

1npm run build

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

1edgio dev

Load the site http://127.0.0.1:3000

Deploying