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)

Publishing your plugin

Each plugin in the 11ty ecosystem is an npm package. That means we need to publish our plugin to npm. To publish a package on the npm registry, you’ll need an account.

You can sign up for a free account at npmjs.org.

Once you have an account, you’ll need to add the account to your local npm command line:

npm addUser

The addUser command will require a username and password and may also require two-factor authentication if that’s set up on your npm account.

Once you have a user, you can publish your plugin, but the plugin will publish more than we want. We currently have all our test content. While, in this case, that’s not a lot of files, our end users and projects don’t need to download those files when they just want a functioning plugin.

To remove the files, we can add a .npmignore file to our directory. Those files can remain in GitHub if we use version control but won’t be in the npm repository:

...