A starter repository for building a blog with the Eleventy static site generator implementing a wide range of performance best practices.
Based on the awesome eleventy-base-blog.
Click the "Use this template" button. Alternatively you can clone this repo yourself and push your copy to your favorite git repository.
git clone https://github.com/YOUR_REPO
cd my-blog-name
npm install
npm run watch
npm run build
- Search for "Update me" across files in your editor to find all the site specific things you should update.
- Update the favicons in 'img/favicon/'.
- Otherwise: Knock yourself out. This is a template repository.
- For a simple color override, adjust these CSS variables at the top of
css/main.css
.
:root {
--primary: #e7bf60;
--primary-dark: #f9c412;
}
- Perfect score in applicable lighthouse audits (including accessibility).
- Single HTTP request to First Contentful Paint.
- Very optimized Largest Contentful Paint (score depends on image usage, but images are optimized).
- 0 Cumulative Layout Shift.
- ~0 First Input Delay.
- Generates multiple sizes of each image and uses them in
srcset
. - Generates a blurry placeholder for each image (without adding an HTML element or using JS).
- Transcodes images to AVIF and webp and generates
picture
element. - Transcodes GIFs to muted looping autoplaying MP4 videos for greatly reduced file size.
- Lazy loads images (using native
loading=lazy
). - Async decodes images (using
decoding=async
). - Lazy layout of images and placeholders using
content-visibility: auto
. - Avoids CLS impact of images by inferring and providing width and height (Supported in Chrome, Firefox and Safari 14+).
- Downloads remote images and stores/serves them locally.
- Immutable URLs.
- Defaults to the compact "classless" Bahunya CSS framework.
- Inlines CSS.
- Dead-code-eliminates / tree-shakes / purges (pick your favorite word) unused CSS on a per-page basis with PurgeCSS.
- Minified CSS with csso.
- Immutable URLs for JS.
- Sets immutable caching headers for images, fonts, and JS (CSS is inlined). Automatically configured when deploying on Vercel
- Uses html-minifier with aggressive options.
- Uses rollup to bundle JS and minifies it with terser.
- Prefetches same-origin navigations when a navigation is likely.
- If an AMP files is present, optimizes it.
- Serves fonts from same origin.
- Makes fonts
display:optional
.
- Supports locally serving Google Analytics's JS and proxying it's hit requests to a Vercel Edge Function (other proxies could be easily added).
- Supports sending Core Web Vitals metrics to Google Analytics as events.
- Support for noscript hit requests.
- Avoids blocking onload on analytics requests.
- To turn this on, specify
googleAnalyticsId
inmetadata.json
. (Note, that this is not compatible with the not-yet-commonly used version 4 of Google Analytics.)
- Uses 🚨 as favicon during local development.
- Supports a range of default tests.
- Runs build and tests on
git push
. - Sourcemap generated for JS.
- Share button preferring
navigator.share()
and falling back to Twitter. Using OS-like share-icon. - Support for OGP metadata.
- Support for Twitter metadata.
- Support for schema.org JSON-LD.
- Sitemap.xml generation.
- Read time estimate.
- Animated scroll progress bar…
- …with an optimized implementation that should never cause a layout.
Generates a strong Content-Security-Policy (CSP) using HTTP headers.
- Default-src is self.
- Disallows plugins.
- Generates hash based CSP for the JS used on the site.
- To extend the CSP with new rules, see CSP.js
- Downloaded remote images, and generated sizes are cached in the local filesystem…
- …and SHOULD be committed to git.
.persistimages.sh
helps with this.
This is not an officially supported Google product, but rather Malte's private best-effort open-source project.