Book Image

Eleventy by Example

By : Bryan Robinson
Book Image

Eleventy by Example

By: Bryan Robinson

Overview of this book

11ty is the dark horse of the Jamstack world, offering unparalleled flexibility and performance that gives it an edge against other static site generators such as Jekyll and Hugo. With it, developers can leverage the complete Node ecosystem and create blazing-fast, static-first websites that can be deployed from a content delivery network or a simple server. This book will teach you how to set up, customize, and make the most of 11ty in no time. Eleventy by Example helps you uncover everything you need to create your first 11ty website before diving into making more complex sites and extending 11ty’s base functionality with custom short codes, plugins, and content types. Over the course of 5 interactive projects, you’ll learn how to build basic websites, blogs, media sites, and static sites that will respond to user input without the need for a server. With these, you’ll learn basic 11ty skills such as templates, collections, and data use, along with advanced skills such as plugin creation, image manipulation, working with a headless CMS, and the use of the powerful 11ty Serverless plugin. By the end of this book, you’ll be well-equipped to leverage the capabilities of 11ty by implementing best practices and reusable techniques that can be applied across multiple projects, reducing the website launch time.
Table of Contents (13 chapters)

Creating a basic plugin

For our first example plugin, let’s take the multimedia shortcodes we created in Chapter 5 and convert them into a plugin.

Basic setup

To start, we need to configure our package.json file to be ready for inclusion in external projects. Give your plugin a name and description that will help users find it, and give it a proper version number. In this case, our media shortcode will start at a very low version number. When initializing an npm package, by default, the main variable will be index.js. This is the main file the package expects to run. Our main file isn’t index.js but instead eleventy.config.js. This is so we can run 11ty inside this plugin for testing purposes and external projects can ingest the code properly, as well.

For all the plugins in this chapter, the package.json file should be very similar with the only differences being additional npm packages that need to be installed:

  "name": "eleventy...