Skip to content

cloudfour/eleventy-patterns

Repository files navigation

Eleventy Patterns

(WIP) A pattern library and prototyping environment, built with Eleventy and Gulp. It uses Handlebars for templating, Sass for CSS processing, and Rollup for javascript transpilation and bundling.

You're not meant to include this as a module. Instead, use this as a template repository and then tweak it to fit your needs. This makes it easier to directly edit the configuration without this project acting as a middleman between you and your config files.

This project includes some custom CLI commands to help you quickly iterate and scaffold out new patterns and prototypes.

Getting Started

Once you've copied this project, run the following commands to get up and running:

Installation

  1. npm ci — Install necessary dependencies.
  2. npm start — Compile the project, start a server, and watch for updates.
  3. Review the pattern and prototype examples to get a feel for the site structure and scaffolding.
  4. npm run removeExamples — Delete the example pattern and prototype. Use caution if you've made changes of your own! This will remove and modify files.
  5. npm run new prototype — Create your first prototype! This command will scaffold out all the files necessary for a new prototype
  6. npm run new pattern — Create your first pattern! This command will scaffold out all the files necessary for a new pattern

About

(WIP) A boilerplate template used to quickly generate pattern libraries and prototyping environments

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published