Code Monkey home page Code Monkey logo

pwa-psa'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.

Clone this project and use it to create your own Eleventy blog.

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

Philosophy

  • Minimal code (HTML, CSS & JS). Add what you need
  • SEO-friendly
  • ๐Ÿš€ Production-ready

Requirements

  • Node.js and npm

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:

Netlify Deploy button

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 Ixartz

pwa-psa's People

Contributors

keithjgrant avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.