bymattlee-11ty-starter — Eleventy Tool Template

SHA-256: fe4c9c36aa774c73d558d6659cded355e3d84ac4a807341c852fac987d6b2fc6

2026-10-01T14:43:44.138Z

![ByMattLee 11ty Starter Screenshot](http://hosted.bymattlee.com/github/bymattlee-11ty-starter-screenshot.jpg)

# ByMattLee 11ty Starter

A starter boilerplate powered by [11ty](https://www.11ty.dev/), [Sanity](https://www.sanity.io/), [Gulp](https://gulpjs.com/), [Tailwind CSS](https://tailwindcss.com/), [rollup.js](https://rollupjs.org/), [Alpine.js](https://alpinejs.dev/) and [Taxi.js](https://taxi.js.org/).

[VIEW DEMO](https://bymattlee-11ty-starter.netlify.app/)

---

## Installation

##### 1. Install Node 16.17.1 LTS: <https://nodejs.org/>

##### 2. Install Yarn

```
$ npm i -g yarn
```

##### 3. Install all dependencies

```
$ yarn
```

---

## Configuration

In `config.js`, update Sanity options and environment URLs for project compilation.

---

## Use

##### Build Files For Development And Initialize Watch

```
$ yarn dev
```

##### Build Files For Staging

```
$ yarn stage
```

##### Build Files For Production

```
$ yarn prod
```

---

## General Features

-   Features [Gulp](https://gulpjs.com/) as the build pipeline that renders HTML, compiles styles and scripts, and optimizes assets.
-   Data is coming from the Sanity Cloud API. This pairs perfectly with the [ByMattLee Sanity Studio Starter](https://github.com/bymattlee/bymattlee-sanity-studio-starter)
-   Spins up a local development environment through Browsersync
-   Browser reload when NJK, JS, image, SVG or asset files are updated
-   Styles are injected when SCSS files are updated

##### Markup

-   Features [11ty](https://www.11ty.dev/) as the static site generator
-   Markup is minified in staging and production environments
-   Site data can be set in `src/site/_data`
-   Pages in `src/site` will be compiled to `dist`
-   `src/site/_includes/layouts/base.njk` serves as the base template for the site
-   `src/site/_includes/partials` contains site partials and components that are reused across the site (modular HTML)

##### Styles

-   Features [Tailwind CSS](https://tailwindcss.com/), a utility-first framework
-   Includes linter (Stylelint), autoprefixer, minification and sourcemap creation
-   SCSS files are located in `src/assets/scss`
-   `main.scss` in `src/assets/scss` serves as the base that includes the other dependent SASS files
-   `main.scss` gets compiled to `dist/assets/css/main.min.css`
-   `.stylelintrc` contains the settings for Stylelint
-   Info about class namespacing can be found in `src/assets/scss/main.scss`
-   Unused CSS (PurgeCSS) will be removed in staging and production builds

##### Scripts

-   Features [rollup.js](https://rollupjs.org/guide/en/) as the module bundler
-   Includes linting (ESLint), concatenation, minification and sourcemap creation
-   Includes [Taxi.js](https://taxi.js.org/) for seamless page transitions
-   Includes a custom framework for reuseable content animations
-   Includes [Alpine.js](https://alpinejs.dev/) for declarative DOM manipulation
-   `main.js` in `src/assets/js` serves as the main JS file that includes and runs all components and will be compiled to `dist/assets/js/main.min.js`
-   All local components should be placed in `src/assets/js/components`
-   All vendor JS can be manually added to `src/assets/js/vendors` if not found on Yarn
-   `.eslintrc` contains the settings for ESLint

##### Images

-   Place all unoptimized images in the `src/assets/images` directory
-   They will then be optimized and placed in `dist/assets/images`
-   Responsive images will be generated at the following widths (if larger): 200w, 400w, 600w, 800w, 1000w, 1200w, 1400w, 1600w, 1800w
-   Use `imageSrc` shortcode to render responsive `srcset` in markup

##### SVGS

-   Place all SVG files in the `src/assets/svg` directory
-   They will then be optimized and added to a sprite at `dist/assets/svg/sprite.svg`

##### Other Assets

-   All assets (fonts, videos, swfs, etc) under `src/assets` will be copied to `dist/assets` on build

##### Sitemap

-   Generates a sitemap based on the HTML files in `dist`

##### Robots.txt

-   Generates a robots.txt file
-   Configuration can be found in `src/site/robots.njk`

---

## Tailwind CSS Notes

-   All Tailwind settings can be found in `./tailwind.config.js`
-   Most styles should be written as utility classes in the template markup but custom SCSS can be used for unique properties and/or magic numbers
-   Utilize the [`@apply`](https://tailwindcss.com/docs/functions-and-directives#apply) directive when writing custom SCSS for efficiency:

```scss
svg {
    @apply u-inline-block u-fill-current;
}
```

-   Tailwind settings can be accessed with the [`theme()`](https://tailwindcss.com/docs/functions-and-directives#theme) function:

```scss
.button {
    animation-duration: theme('transitionDuration.normal');
}
```

-   Media queries can be used with the shorthand `screen()` function:

```scss
.button {
    margin-right: 2.8rem;
    @screen sm {
        margin-right: 4.2rem;
    }
}
```

---

## Contact

-   Matt Lee - `@bymattlee` on most platforms
-   Visit my website at [bymattlee.com](https://bymattlee.com)

[![Twitter Follow](https://img.shields.io/twitter/follow/bymattlee?style=social)](https://twitter.com/bymattlee)