ixartz / eleventy-starter-boilerplate Goto Github PK

🚀 Eleventy Starter is production-ready with SEO-friendly for quickly starting a blog. ⚡ Built with Eleventy, ESLint, Prettier, Webpack 5, PostCSS, Tailwind CSS 2 and Netlify CMS (optional).

Home Page: https://creativedesignsguru.com

License: MIT License

JavaScript 35.26% HTML 4.12% CSS 21.83% EJS 38.79%

eleventy tailwind-css starter-kit boilerplate blog blogging eleventy-theme eleventy-sample eleventy-template eleventy-site

eleventy-starter-boilerplate's Introduction

Eleventy Starter Boilerplate

🚀 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 logo
public/apple-touch-icon.png, public/favicon.ico, public/favicon-16x16.png and public/favicon-32x32.png: your blog favicon, you can generate from https://favicon.io/favicon-converter/
src/_data/site.json: your blog configuration
src/_includes/layouts: your blog HTML layout
src/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 folder
src/_includes/layouts/base.ejs, the loaded script netlify-identity-widget.js and the inline script if (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

See LICENSE for more information.

Made with ♥ by CreativeDesignsGuru

eleventy-starter-boilerplate's People

Contributors

Stargazers

Watchers

eleventy-starter-boilerplate's Issues

Disable webp conversion in webpack (images not working on iOS)

The default webpack config will convert images to webp (but keep the file extension).
Webp is not a bad format in itself, but without further configuration to also have png fallbacks,
the images will break on iOS.

The usual flow with webp seems to be to detect the user agent or read Accept headers
and only serve webp to android/PC (or possibly use <picture> with multiple sources).

(In addition, my images grew with 5kB and 10kB when they were webp...)

Diff:

--- a/webpack.config.js
+++ b/webpack.config.js
@@ -76,10 +76,6 @@ module.exports = {
               gifsicle: {
                 interlaced: true,
               },
-              // the webp option will enable WEBP
-              webp: {
-                quality: 80,
-              },
             },
           },
         ],

Pre-sale question: do you maintain you templates?

I saw https://creativedesignsguru.com/category/eleventy/.

Really, what I'm looking in such a template is the developer experience. I saw this was updated 8 months ago.
Does the premium templates are based on this project?

I want to find a great template to work along tailwindui.

Thanks!

How to change homepage?

I found this template via the Netlify and would be sooooooo excited about it except that it's making me feel like an idiot. I've worked mostly with PHP/Drupal the last ten years and am new to 11ty and ejs etc.

I want to make the current "home" page accessible via /blog url and create a custom page for home.

But all I can do is break it.

I keep getting Cannot GET / (even on localhost:8080) and can't figure out what causes it. It seems totally random.

I'm able to add a /contact page and can add it to the menu. But can't do that for /blog. Nor can I figure out how to replace the homepage with a custom page via an index.md file.

Any chance you could help me here?

How to add home and about page

I was roaming around the web in the search of a simple yet attractive blogging site with netlify cms . this site is all i want . I configured it according to me and it looks awesome.but i am facing one issue i want to add a home and about page to my site. How can i do so ? Thank you in advance!

.ejs over .nunjucks?

Was wondering if there was a specific reason for choosing .ejs of nunjucks? A lot of the eleventy plugins ( Reading time for example) are only available for nunjucks.

how does post.ejs work? how to create additional template files like that?

Sorry this question might not be specifically unique to this starter theme... I'm inexperienced with both 11ty and ejs and so I'm not sure which of those this question is most suited to.

How does post.ejs file get automatically used for pages in the src/posts directory? Can you explain how I can do that for other pages? Or could you point me to the part in the code where this is made?