lucht/README.md

# Eleventonia

A mildly opinionated [Eleventy](https://11ty.dev) starter project.

[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/mattdecamp/eleventonia)  

## Features

* HTML Minification
* CSS Pipline (SCSS > CleanCSS > Inline)
* Eleventy Dev Server
* Eleventy SVG Icon Sprites
* Eleventy RSS
* Date Formatting Filter
* Post Excerpts

## Getting Started

Navigate to the root folder of the site and run:

```
npm install
```

To run the development environment:

```
npm run dev
```

To build for production:

```
npm run build
```
For additional eleventy commands, visit the [Eleventy command line usage page](https://www.11ty.dev/docs/usage/).

## 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

* [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)
create readme 2021-09-02 01:19:02 +00:00			`# Eleventonia`

added 11ty homepage link 2021-12-10 01:56:34 +00:00			`A mildly opinionated [Eleventy](https://11ty.dev) starter project.`
netlify deploy button 2021-09-03 02:04:42 +00:00
Added additional repo information Still in a draft format 2021-12-08 01:47:05 +00:00			`[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/mattdecamp/eleventonia)`

			`## Features`

			`* HTML Minification`
➕ more detailed getting started guide, sass info 2023-06-08 19:16:46 +00:00			`* CSS Pipline (SCSS > CleanCSS > Inline)`
			`* Eleventy Dev Server`
Added additional repo information Still in a draft format 2021-12-08 01:47:05 +00:00			`* Eleventy SVG Icon Sprites`
			`* Eleventy RSS`
			`* Date Formatting Filter`
Added additional feature bullet point 2021-12-09 01:50:07 +00:00			`* Post Excerpts`
Added additional repo information Still in a draft format 2021-12-08 01:47:05 +00:00
			`## Getting Started`

Update README.md 2021-12-08 01:53:35 +00:00			`Navigate to the root folder of the site and run:`
Added additional repo information Still in a draft format 2021-12-08 01:47:05 +00:00
			```
			`npm install`
			```

Update README.md 2021-12-08 01:53:35 +00:00			`To run the development environment:`
Added additional repo information Still in a draft format 2021-12-08 01:47:05 +00:00
			```
➕ more detailed getting started guide, sass info 2023-06-08 19:16:46 +00:00			`npm run dev`
Added additional repo information Still in a draft format 2021-12-08 01:47:05 +00:00			```

Update README.md 2021-12-08 01:53:35 +00:00			`To build for production:`
Added additional repo information Still in a draft format 2021-12-08 01:47:05 +00:00
			```
➕ more detailed getting started guide, sass info 2023-06-08 19:16:46 +00:00			`npm run build`
Added additional repo information Still in a draft format 2021-12-08 01:47:05 +00:00			```
			`For additional eleventy commands, visit the [Eleventy command line usage page](https://www.11ty.dev/docs/usage/).`

➕ more detailed getting started guide, sass info 2023-06-08 19:16:46 +00:00			`## 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`
Added additional repo information Still in a draft format 2021-12-08 01:47:05 +00:00
added credit links This reverts commit 22073c608716eb4d0e2ef090df08c1a0f01ef503. 2021-12-10 01:49:56 +00:00			`* [Andy Bell](https://github.com/hankchizljaw/hylia)`
➕ more detailed getting started guide, sass info 2023-06-08 19:16:46 +00:00			`* [Max Böck](https://github.com/maxboeck/eleventastic)`
added 11ty homepage link 2021-12-10 01:56:34 +00:00			`* [Phil Hawksworth](https://github.com/philhawksworth/eleventyone)`
➕ more detailed getting started guide, sass info 2023-06-08 19:16:46 +00:00			`* [Zach Leatherman](https://11ty.dev)`
			`* [Thomas Semmler](https://helloyes.dev)`