Skip to content

agility/agilitycms-eleventy-starter

Repository files navigation

Agility CMS & Eleventy Starter

This is sample Eleventy starter site that uses Agility CMS and aims to be a foundation for building fully static sites using Eleventy and Agility CMS.

Live Website Demo

New to Agility CMS? Sign up for a FREE account

About This Starter

  • Uses Nunjucks templating engine
  • Connected to a sample Agility CMS Instance for sample content & pages
  • Supports full Page Management
  • Provides a functional structure that dynamically routes each page based on the request, loads a Page Templates dynamically, and also dynamically loads and renders appropriate Agility CMS Page Modules (as Nunjuck templates)

Tailwind CSS

This starter uses Tailwind CSS, a simple and lightweight utility-first CSS framework packed with classes that can be composed to build any design, directly in your markup.

It also comes equipped with Autoprefixer, a plugin which use the data based on current browser popularity and property support to apply CSS prefixes for you.

Getting Started

To start using the Agility CMS & Eleventys Starter, sign up for a FREE account and create a new Instance using the Blog Template.

  1. Clone this repository
  2. Run npm install or yarn install
  3. Rename the .env.example file to .env
  4. Retrieve your GUID and API Keys (Preview/Fetch) from Agility CMS by going to Settings > API Keys.

How to Retrieve your GUID and API Keys from Agility

Running the Site Locally

Development Mode

When running your site in development mode, you will see the latest content in real-time from the CMS.

yarn

  1. yarn install
  2. yarn start

To clear your content cache locally, run yarn clean

npm

  1. npm install
  2. npm run start

To clear your content cache locally, run npm run clean

Production Mode

When running your site in production mode, you will see the published from the CMS.

yarn

  1. yarn build
  2. npx http-server _site

npm

  1. npm run build
  2. npx http-server _site

Deploying Your Site

Notes

How to Register Page Modules

To create a new Page Module, create a new Nunjuck template within the /src/includes/agility-pageModules directory.

How to Register Page Modules

To create a new Page Templates, create a new Nunjuck template within the /src/includes/agility-pageTemplates directory.

How to Preview Content

Resources

Agility CMS

Eleventy

Tailwind CSS

Community

Feedback and Questions

If you have feedback or questions about this starter, please use the Github Issues on this repo, join our Community Slack Channel or create a post on the Agility Developer Community.