README.md

Pragmatics Eleventy boilerplate

Pragmatics boilerplate for 11ty projects.

Summary

• Getting Started
• Features
• Testing
• Built With
• Contributing
• Versioning
• Authors
• License
• Acknowledgments

Getting started

Installation

To install the necessary packages, run this command in the root folder of the site:

yarn

Usage

• Run yarn start for a development server and live reloading
• Run yarn build to generate a production build

Features

• HTML Minification
• CSS Pipeline (Sass, CSSNano, PurgeCSS, Autoprefixer, Critical CSS)
• JS Bundling (Webpack)
• SVG Icon Sprite Generation
• No external builds, everything runs through 11ty

Testing

We use Jest for testing, run npm test to run all tests.

Built With

• Eleventy - for static site generation
• Webstorm - for development
• Github - for versioning and deployment
• Jest - for testing
• Contributor Covenant - for the Code of Conduct
• Creative Commons - to choose the license

Contributing

Please read CONTRIBUTING.md for details on our the process for submitting issues and pull requests to us. This repository has a code of conduct, we will remove things that do not respect it.

Versioning

We use SemVer for versioning. For the available versions, see the tags on this repository.

Authors

See the list of contributors who participated in this project.

License

This project is licensed under the ISC License.

Acknowledgements

The following guidelines, methodologies and architectures have been used as inspiration for this package:

[list of acknowledgement links]