diff --git a/README.md b/README.md index aac086c..3b504dc 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,8 @@ A mildly opinionated [Eleventy](https://11ty.dev) starter project. ## Features * HTML Minification -* CSS Pipeline (Sass > CleanCSS) +* CSS Pipline (SCSS > CleanCSS > Inline) +* Eleventy Dev Server * Eleventy SVG Icon Sprites * Eleventy RSS * Date Formatting Filter @@ -24,20 +25,39 @@ npm install To run the development environment: ``` -npm run eleventy:dev +npm run dev ``` To build for production: ``` -npm run eleventy:prod +npm run build ``` - For additional eleventy commands, visit the [Eleventy command line usage page](https://www.11ty.dev/docs/usage/). -## Credits and Thanks To +## Editing Styles +Edit and amend as needed. The main Sass files are under the `/assets` folder. +### Sass Folder Structure +``` +src + /assets + /styles + /scss + /base + /components + /utility + main.scss +``` +The development environment watches for changes to the Sass files and pushes changes to `main.css` in the `/includes` folder. Eleventy then pushes the styles inline in the `` of the base page template. + +## Prodution Build +At build time, all the html files are minified. + + +## Thanks To -* [Zach Leatherman](https://11ty.dev) -* [Max Böck](https://github.com/maxboeck/eleventastic) * [Andy Bell](https://github.com/hankchizljaw/hylia) +* [Max Böck](https://github.com/maxboeck/eleventastic) * [Phil Hawksworth](https://github.com/philhawksworth/eleventyone) +* [Zach Leatherman](https://11ty.dev) +* [Thomas Semmler](https://helloyes.dev)