Build with Jekyll

Create a Jekyll site from an Azion template or with the Azion CLI, and deploy it to an Azion domain.

Last updated

View as Markdown Agent setup

You can deploy a Jekyll site on Azion from a template in Azion Console or with the Azion CLI. Both routes give you a Jekyll site that runs on Azion and answers on an Azion domain.

Azion serves a Jekyll site as a static application. The project configuration uploads the ./_site folder to a storage bucket, and an application serves the files from that bucket. For the other frameworks Azion builds, refer to Frameworks compatibility.

Pick a route below. The prerequisites and the deploy steps change with your choice.

Prerequisites

  • Access to Azion Console. To sign in, refer to How to access Azion Console.
  • A GitHub account. The template deploy asks you to connect it.
  • The Azion CLI, installed and logged in. To set it up, refer to Azion CLI quickstart.
  • Node.js 18 or later, and npm.
  • Ruby and Bundler.
  • A terminal and a code editor.

Jekyll templates

Each template is a Jekyll project that Azion deploys for you. The Console route starts from one of these templates:

TemplateUse
Jekyll BoilerplateStarter project
Jekyll CartShopping cart
SupplyE-commerce

Jekyll Cart and Supply share one guide. For more information on templates, refer to Azion Marketplace. In the CLI route, the template picker of azion init lists the same three templates.

Deploy the site

Each route builds the Jekyll project and creates the resources that serve it on Azion. Use the panel of your route:

To create the project, run azion init and give it a name. In the preset picker, select Jekyll. In the template picker, select a template:

azion init --name my-site --auto -y

With -y, the command installs the dependencies. With --auto, it does not ask about a local development server or a deploy. For the questions it asks without these options, refer to Azion CLI init. With the Jekyll Boilerplate template, the output is:

Text
01? Choose a preset: [Use arrows to move, type to filter]
02> AI Studio
03 Angular
04 Astro
05 Docusaurus
06 Eleventy
07 Emscripten
08 Gatsby
09 Hexo
10 Hono
11 Hugo
12 Javascript
13 Jekyll
14 Next
15 Nuxt
16 OpenNextJS
17 Preact
18 Qwik
19 React
20 Rustwasm
21 Stencil
22 Svelte
23 Typescript
24 Vitepress
25 Vue
26 Vuepress
27? Choose a preset: Jekyll
28? Choose a template: [Use arrows to move, type to filter]
29> Jekyll Boilerplate
30 Jekyll Cart
31 Supply
32? Choose a template: Jekyll Boilerplate
33
34Fetching selected template...
35
36Template successfully fetched
37Template successfully configured
38Installing application dependencies
39up to date, audited 1 package in 326ms
40found 0 vulnerabilities
41…
42[Azion] [Build] › ℹ info Using preset: jekyll
43[Azion] [Build] › ✔ success Build completed successfully with only azion.config
44[Azion] [IaC] › ✔ success Manifest generated successfully at <project-dir>/my-site/.edge/manifest.json
45If you want to start a local development server later, run 'azion dev'
46Make sure to change to the new working directory before running building or deploying your project
47If you want to deploy your application later, run 'azion deploy'
48Make sure to change to the new working directory before running building or deploying your project
49Your application my-site was initialized successfully

The project is in a my-site folder. Its azion.config.cjs file sets the jekyll preset. It also uploads ./_site to a storage bucket that workloads can read but not change. For every setting in the file, refer to azion.config.js.

To build the site, go to the project folder and run azion build:

Shell
01cd my-site
02azion build

The command runs Azion Bundler with the jekyll preset, which runs bundle install && bundle exec jekyll build, so the Bundler version that Gemfile.lock names must be installed. For the flags of the command, refer to Azion CLI build.

To deploy the site, run azion deploy in the project folder:

azion deploy

The command uploads the project and opens the Console page of the deploy in your browser. It also prints the URL of that page, for when the browser does not open. At the end, it prints the URL of the site’s domain. For the full output and every flag, refer to Azion CLI deploy.

To test the site on your machine before the deploy, refer to Azion CLI dev. For a Jekyll project that already exists, run azion link in its folder and select the Jekyll preset. For more information, refer to Azion CLI link.

To deploy a Jekyll template from Azion Console:

Open the templates

Access Azion Console > Create > Templates.

Search for Jekyll

In Search by name, framework, or keyword, enter Jekyll.

Select a Jekyll template
Connect your GitHub account

When the form shows GitHub Connection, select Connect with GitHub. Then install the Azion GitHub App.

Select a Git Scope

In Git Scope, select the scope of the template.

Fill in the settings the template asks for
Select Deploy

The deploy page opens and shows the Deploy Log during the build. After a successful deploy, the page shows Successfully created!, the domain URL, and a Manage button that opens the application.

Check the site

The deploy gives you the URL of the site’s Azion domain, in the form https://xxxxxxxxxx.map.azionedge.net. The Console deploy page shows the URL, and azion deploy prints it at the end. Open the URL in a browser to see the Jekyll site.

The first deploy can take several minutes to answer from every location; later deploys take about two minutes. A location that does not have the site yet answers with a 404 page that reads There's nothing here yet. If you get this response, wait and request the URL again.

Next steps

Frameworks compatibilitySee the frameworks and presets that Azion builds.Azion CLI buildChange how the CLI builds the Jekyll project.Azion CLI deployRead the deploy output and the flags that change a deploy.azion.config.jsChange the bucket, cache, and rules that the Jekyll preset generates.