Overview:
The Eleventy starter set (Nunjucks-based) is a template that allows users to quickly set up a static site using the Eleventy static site generator (SSG). This starter set uses Nunjucks templating and includes several features such as responsive images, postCSS, and Tailwind CSS.
Features:
- Nunjucks Templating: This starter set uses Nunjucks as the templating language, allowing for easy customization and modularization of components.
- Responsive Images: The eleventy-img plugin is included, allowing users to easily add and optimize responsive images on their site.
- PostCSS and Tailwind CSS: PostCSS and Tailwind CSS are included, providing a powerful and flexible CSS framework for styling the site.
- Hashed File Names: In production mode, the CSS file is given a hashed file name for caching purposes, improving site performance.
- Local Development: The starter set provides a local development environment using npm scripts, making it easy to preview and make changes to the site locally.
Installation:
To install and set up the Eleventy starter set, follow these steps:
- Clone this repository to a local directory.
- Open the
\_datafolder and update themetadata.jsonandsiteparams.jsonfiles with your site’s specific parameters. - Run
npm installin the root folder to install all the necessary dependencies listed in thepackage.jsonfile. - Run
npm run startfrom your terminal to start the local development server. - Visit
http://localhost:3000in your web browser to view the site. - Explore the sample posts and their corresponding Markdown files to understand how everything works.
- Edit the content files to customize the site according to your needs.
- When ready, deploy the site to your chosen hosting provider.
Summary:
The Eleventy starter set (Nunjucks-based) is a convenient template for setting up a static site using the Eleventy static site generator. With features such as Nunjucks templating, responsive images, and PostCSS with Tailwind CSS, this starter set provides a solid foundation for building and customizing websites. The installation process is straightforward, allowing users to quickly set up a local development environment and make changes to the site before deploying it to a hosting provider.