hypnagaga_old/readme.md
2024-01-30 18:45:38 +01:00

137 lines
4.8 KiB
Markdown

# Eleventy Excellent
Easy to use Eleventy starter, based on the workflow suggested by Andy Bell's [buildexcellentwebsit.es](https://buildexcellentwebsit.es/).
![GitHub Repo stars](https://img.shields.io/github/stars/madrilene/eleventy-excellent?style=flat-square&logo=github&logoColor=white&label=GitHub%20stars)
[![Follow @lene@front-end.social](https://img.shields.io/mastodon/follow/109292536543732634?domain=https%3A%2F%2Ffront-end.social&style=flat-square&logo=Mastodon&logoColor=white&labelColor=%235B4BE1)](https://front-end.social/@lene)
If you end up using this starter, feel free to send me a link, I'd love to see it!
- [Eleventy Excellent](#eleventy-excellent)
- [Preview](#preview)
- [Features](#features)
- [First steps](#first-steps)
- [Deploy directly to Netlify](#deploy-directly-to-netlify)
- [Development](#development)
- [Install dependencies](#install-dependencies)
- [Working locally](#working-locally)
- [Creating a production build](#creating-a-production-build)
- [Built with Eleventy Excellent](#built-with-eleventy-excellent)
- [Credits and Thank yous](#credits-and-thank-yous)
## Preview
https://eleventy-excellent.netlify.app/
## Features
**This starter includes:**
- The whole CSS workflow as suggested by buildexcellentwebsit.es
- Accessible site navigation, editable in `src/_data/navigation.js`
- Image optimization with Eleventy-img _([see blog post](https://eleventy-excellent.netlify.app/blog/post-with-an-image/))_
- Youtube embed with lite-youtube _([see blog post](https://eleventy-excellent.netlify.app/blog/post-with-a-video/))_
- Easy resource fetching with eleventy-fetch _([see blog post](https://eleventy-excellent.netlify.app/blog/post-with-fetched-content/))_
- Syntax highlighting via eleventy-plugin-syntaxhighlight _([see blog post](https://eleventy-excellent.netlify.app/blog/post-with-some-code/))_
- Advanced markdown handling _([see blog post](https://eleventy-excellent.netlify.app/blog/post-with-all-the-markdown/))_
- 301 redirects for Netlify _([see blog post](https://eleventy-excellent.netlify.app/blog/post-with-301-redirects/))_
- Automatically generated Open Graph images for blog posts _([see blog post](https://eleventy-excellent.netlify.app/blog/open-graph-images/))_
- How Tailwind CSS is used here _([see blog post](https://eleventy-excellent.netlify.app/blog/what-is-tailwind-css-doing-here/))_
- SEO basics (XML-sitemap, metadata)
- dayjs handling dates & times
- Bundling via esbuild
- RSS feed
- Links to social networks
- Mastodon domain verification snippet
- carbon.txt
- dark and light mode
- Tags
- Blog pagination
## First steps
[Please read the Get started docs!](https://eleventy-excellent.netlify.app/get-started/)
## Deploy directly to Netlify
[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/madrilene/eleventy-excellent)
## Development
### Install dependencies
```
npm install
```
### Working locally
Starts watch tasks to compile when changes detected
```
npm start
```
### Creating a production build
Minify JS, CSS and HTML.
```
npm run build
```
## Built with Eleventy Excellent
[Sites that are based on / built with Eleventy Excellent. ](https://eleventy-excellent.netlify.app/built-with/)
Add your site by submitting a pull request! :)
## Credits and Thank yous
**Andy Bell**
His CSS methodology "CUBE" makes sense to me. It goes hand in hand with _Every Layout_ (which he co-authors). He has recently published an approach that incorporates Tailwind CSS into his methodology. Also, I learned how to use Eleventy in 2020 with his (now free) course.
- https://buildexcellentwebsit.es/
- https://cube.fyi/
- https://learneleventyfromscratch.com/
**Heydon Pickering**
I strongly orientate myself on Heydon's approaches and really love his books.
- https://every-layout.dev/
- https://inclusive-components.design/
**Zach Leatherman**
He is developing Eleventy and is constantly making it even better!
- https://www.11ty.dev/
- https://www.zachleat.com/
**Stephanie Eckles**
Stephanie provides a lot of resources for Eleventy and modern CSS.
- https://smolcss.dev/
- https://moderncss.dev/
**Aleksandr Hovhannisyan**
I love order and structure. Aleksandr does this in an exemplary way, which is why I based the structure of eleventy.js on his personal site. The 301 redirect solution I'm using is from his blog.
- https://github.com/AleksandrHovhannisyan
- https://www.aleksandrhovhannisyan.com/blog/eleventy-netlify-redirects/
**Manuel Matuzović**
Manuel is an accessibility expert. The menu I'm using is from one of his articles on web.dev.
- https://web.dev/website-navigation/
- https://www.matuzo.at/
**Bernard Nijenhuis**
Bernard wrote the article on which the Open Graph Images implementation is based.
- https://bnijenhuis.nl/notes/automatically-generate-open-graph-images-in-eleventy/