Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
dandevri committed Feb 10, 2021
1 parent db8cf30 commit df5dffb
Showing 1 changed file with 18 additions and 9 deletions.
27 changes: 18 additions & 9 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,19 @@ Opinionated micro front-end that can be used to _create a one-pager_. Great for

## Features ✨

* Inlines and minifies CSS using `clean-css`
* Inlines and minifies JavaScript using `terser`
* Includes a `metadata.json` global data file
* Includes a `base.njk` layout template
* Includes a `assets folder` for static files (images, fonts etc.)
* Inlines and minifies CSS using [`clean-css`][css]
* Inlines and minifies JavaScript using [`terser`][terser]
* Includes a `metadata.json` [global data file][data]
* Includes a `base.njk` [layout template][layout]
* Includes a `assets folder` for [static files][copy] (images, fonts etc.)

> This is a _*skeleton project_ so it doesn't include any components or basic styling. It's a _*bring your own_ front-end.
## Usage

1. Update the `metadata.json` file with your own site details
2. Edit the `index.njk` file and start coding your website!
3. _Optional:_ [Deploy the site][deploy] to Netlify.


## Install
Expand Down Expand Up @@ -58,15 +59,23 @@ micro-site/
├── index.njk/ // landing page
└── .eleventy.js // 11ty configurations
```

## Roadmap

- [ ] Image optimization with `eleventy-image`
- [ ] Asset caching with `eleventy-cache-assets`
- [ ] Syntax highlighting support with `eleventy-plugin-syntaxhiglight`
## License

[MIT][license] © [Danny de Vries][author]

[11ty]: https://www.11ty.io/]
[postcss]: https://postcss.org/
[nunjucks]: https://mozilla.github.io/nunjucks/
[autoprefixer]: https://github.com/postcss/autoprefixer
[deploy]: https://app.netlify.com/start/deploy?repository=https://github.com/voightco/micro-site
[css]: https://github.com/jakubpawlowicz/clean-css
[terser]: https://github.com/terser/terser
[data]: https://www.11ty.dev/docs/data/
[layout]: https://www.11ty.dev/docs/layouts/
[copy]: https://www.11ty.dev/docs/copy/
[author]: https://github.com/dandevri
[license]: license

[tailwind]: https://tailwindcss.com/

0 comments on commit df5dffb

Please sign in to comment.