Eleventy Web Starter is a lightweight Eleventy boilerplate utilising, ESBuild Tailwind and PostCSS.
MIT License
An opinionated starter template for building static websites using Eleventy. This starter kit is designed to help you quickly set up a modern, fast, and efficient static site with best practices for templating, styling, and performance optimisation.
Make sure you have the following installed on your machine:
Clone the Repository:
git clone https://github.com/chrissy-dev/eleventy-web-starter.git
cd eleventy-web-starter
Install Dependencies:
npm install
Or, if using Yarn:
yarn install
Start the local development server:
npm run dev
This command will:
http://localhost:8080
To generate a production-ready build, run:
npm run build
The output will be in the dist
folder, optimised and ready for deployment.
Here's an overview of the core structure of this project:
eleventy-web-starter/
├── src/ # Source files for the project
│ ├── _data/ # Data files in JSON or JS format
│ ├── _includes/ # Reusable components
│ ├── _layouts/ # Reusable layouts
│ ├── _assets/ # Assets - JS, CSS (Tailwind)
├── .eleventy.js # Eleventy configuration file
├── package.json # Node dependencies and scripts
├── tailwind.config.js # Tailwind Config
├── postcss.config.js # PostCSS Config
└── README.md # Project documentation
npm start
: Start the development server with live reload.npm run build
: Create a production build of the site.npm run clean
: Remove the dist
folder to reset the build.This starter is optimised for deployment on popular static site hosts. Follow the instructions below for different providers:
Click the button below to deploy to Netlify:
Configure the build settings:
npm run build
dist
Install the Vercel CLI if not already installed:
npm install -g vercel
Deploy using the Vercel CLI:
vercel
Follow the prompts to complete the deployment.
Contributions, issues, and feature requests are welcome! Feel free to check the issues page.
To contribute:
git checkout -b feature-branch
)git commit -m 'Add a new feature'
)git push origin feature-branch
)This project is MIT licensed.
If you have any questions or need further assistance, feel free to reach out: