Eleventy Starter Boilerplate
Clone this project and use it to create your own Eleventy blog. You can check a Eleventy templates demo.
Features
Production-ready in mind:
π₯ 11ty for Static Site Generatorπ¨ Integrate with Tailwind CSS (with PurgeCSS, remove unused CSS)π PostCSS for processing Tailwind CSSβ‘οΈ Lazy load images with lazysizesβ¨ Compress image with Imageminπ Syntax Highlighting with Prism.jsβ Minify HTML & CSS with HTMLMinifier and cssnanoβοΈ Linter with ESLintπ Code Formatter with Prettierπ¨ Live reloadπ¦ Module Bundler with Webpackπ¦ Templating with EJSπ€ SEO metadata and Open Graph tagsβοΈ JSON-LD for richer indexingπΊ Sitemap.xmlβ οΈ 404 pageπ Paginationβ Cache bustingπ― Maximize lighthouse scoreπ Include a FREE minimalist blog themeπ Netlify CMS (optional)
Philosophy
- Minimal code (HTML, CSS & JS). Add what you need
- SEO-friendly
π Production-ready
Requirements
- Node.js and npm
Eleventy Themes)
Premium Themes (Blue Dark Eleventy Theme | Blue Eclatant Eleventy Theme |
---|---|
Blue Modern Eleventy Theme | Blue Minimalist Eleventy Theme |
---|---|
Getting started
Run the following command on your local environment:
git clone --depth=1 https://github.com/ixartz/Eleventy-Starter-Boilerplate.git my-project-name
cd my-project-name
npm install
Then, you can run locally in development mode with live reload:
npm run dev
Open http://localhost:8080 with your favorite browser to see your blog.
Project structure
.
βββ public # Static files
β βββ assets
β βββ images # Images not needed by Webpack
βββ src
βββ _data # Eleventy data folder
βββ _includes
β βββ layouts # HTML layout files
βββ assets # Assets folder that needs to be processed by Webpack
β βββ images
β β βββ posts # Images used in your blog posts (will be compressed by Webpack)
β βββ styles # Your blog CSS files
βββ posts # Your blog posts
Customization
You can easily configure Eleventy Starter Boilerplate. Please change the following file:
public/assets/images/logo.png
: your blog logopublic/apple-touch-icon.png
,public/favicon.ico
,public/favicon-16x16.png
andpublic/favicon-32x32.png
: your blog favicon, you can generate from https://favicon.io/favicon-converter/src/_data/site.json
: your blog configurationsrc/_includes/layouts
: your blog HTML layoutsrc/assets/styles/main.css
: your blog CSS file using Tailwind CSS
Deploy to production
You can see the results locally in production mode with:
npm run serve
The generated HTML and CSS files are minified. It will also removed unused CSS from Tailwind CSS.
You can create an optimized production build with:
npm run build
Now, your blog is ready to be deployed. All generated files are located at _site
folder, which you can deploy with any hosting service.
Deploy to Netlify
Clone this repository on own GitHub account and deploy to Netlify:
Remove Netlify files and Netlify CMS
If you don't use Netlify, you can easily remove all Netlify related files:
public/admin
, the entier foldersrc/_includes/layouts/base.ejs
, the loaded scriptnetlify-identity-widget.js
and the inline scriptif (window.netlifyIdentity) { ...
netlify.toml
, the entire file
Contributions
Everyone is welcome to contribute to this project. Feel free to open an issue if you have question or found a bug.
License
Licensed under the MIT License, Copyright Β© 2020
See LICENSE for more information.
Made with