Skip to content

DevZoneOne/starter.eleventy

Repository files navigation

Starter template for Eleventy

This is a example markdown / liquid starter template for new Eleventy (11ty) projects. It has preconfigured:

  • Eleventy
    • Navigation plugin
    • RSS plugin
    • Render plugin
    • HTML Base plugin
    • Markdown configured with footnotes
  • Liquid based scripts1 (instead of nunjucks)
  • SASS2
  • PostCSS
    • PostCSS hash
    • AutoPrefixer
    • CSS Nano
  • Prettier (on local builds)
  • HTML Minifier (on production builds)
  • Example code
    • Shortcode (year)
    • Filters (htmlDate, readableDate, head, min, md)

Detailed description

In this readme, you find how to get started with this template, but this starter is developed as part of a blog article on DevZone.one, you find a much more detailed walk-through on DevZone.one - Get started with Eleventy

Demo

The latest version of this template is deployed on: https://starter-eleventy.devzoneone.app (Please note: The template and therefore the demo only contains a minimum of styling, as that is the purpose of this starter template)

How to use the template

Don't fork this repository, that would give you all the branches and commit history, not what you want.

  • GitHub If you're going to put your repo on Github, use the green Use this template button and either directly create a new repo, or open a codespace (online IDE). This will copy over all the files but without any git-related history.

Start developing

  1. Install the dependencies:
    $ npm i
  2. Run locally in watch mode (with HTML code prettified):
    $ npm start
  3. Build for production (with HTML code minified):
    $ npm run build

Inspiration & Credits

This template starter is partly based on:

Footnotes

  1. RSS feeds still need to be rewritten.

  2. Styling kept minimal on purpose.