spencer/lucht
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

➕ more detailed getting started guide, sass info

Browse source
This commit is contained in:
Matt DeCamp 2023-06-08 15:16:46 -04:00
parent f2680031f2
commit c13b87d596
1 changed files with 27 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

34
README.md
View file

@ -7,7 +7,8 @@ A mildly opinionated [Eleventy](https://11ty.dev) starter project.
## Features ## Features
* HTML Minification * HTML Minification
* CSS Pipeline (Sass > CleanCSS) * CSS Pipline (SCSS > CleanCSS > Inline)
* Eleventy Dev Server
* Eleventy SVG Icon Sprites * Eleventy SVG Icon Sprites
* Eleventy RSS * Eleventy RSS
* Date Formatting Filter * Date Formatting Filter
@ -24,20 +25,39 @@ npm install
To run the development environment: To run the development environment:
``` ```
npm run eleventy:dev npm run dev
``` ```
To build for production: 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/). 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 `<head>` 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) * [Andy Bell](https://github.com/hankchizljaw/hylia)
* [Max Böck](https://github.com/maxboeck/eleventastic)
* [Phil Hawksworth](https://github.com/philhawksworth/eleventyone) * [Phil Hawksworth](https://github.com/philhawksworth/eleventyone)
* [Zach Leatherman](https://11ty.dev)
* [Thomas Semmler](https://helloyes.dev)