Awesome
Eleventy Starter Boilerplate
<p align="center"> <a href="https://creativedesignsguru.com/demo/Eleventy-Starter-Boilerplate/eleventy-starter-boilerplate-presentation/"><img src="public/assets/images/eleventy-js-starter-boilerplate.png?raw=true" alt="Eleventy starter banner"></a> </p>š Eleventy Starter Boilerplate is production-ready with SEO-friendly for quickly starting a blog. ā”ļø Built with Eleventy, ESLint, Prettier, Webpack, PostCSS, Tailwind CSS and Netlify CMS (optional).
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
Premium Themes (Eleventy 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 ā„ by CreativeDesignsGuru