50 lines
2.7 KiB
Markdown
50 lines
2.7 KiB
Markdown
|
<p align="center"><img src="https://www.11ty.dev/img/logo-github.svg" width="200" height="200" alt="eleventy Logo"></p>
|
|||
|
|
|
|||
|
|
# eleventy 🕚⚡️🎈🐀
|
|||
|
|
|
|||
|
|
A simpler static site generator. An alternative to Jekyll. Written in JavaScript. Transforms a directory of templates (of varying types) into HTML.
|
|||
|
|
|
|||
|
|
Works with HTML, Markdown, JavaScript, Liquid, Nunjucks, Handlebars, Mustache, EJS, Haml, and Pug.
|
|||
|
|
|
|||
|
|
## ➡ [Documentation](https://www.11ty.dev/docs/)
|
|||
|
|
|
|||
|
|
- Please star [this repo on GitHub](https://github.com/11ty/eleventy/)!
|
|||
|
|
- Follow us on Twitter [@eleven_ty](https://twitter.com/eleven_ty)
|
|||
|
|
- Support [11ty on Open Collective](https://opencollective.com/11ty)
|
|||
|
|
- [11ty on npm](https://www.npmjs.com/org/11ty)
|
|||
|
|
- [11ty on GitHub](https://github.com/11ty)
|
|||
|
|
- Continuous Integration:
|
|||
|
|
- [GitHub Actions](https://github.com/11ty/eleventy/actions?query=workflow%3A.github%2Fworkflows%2Fci.yml)
|
|||
|
|
|
|||
|
|
[](https://www.npmjs.com/package/@11ty/eleventy) [](https://github.com/11ty/eleventy/issues) [](https://github.com/prettier/prettier) [](https://www.npmjs.com/package/@11ty/eleventy)
|
|||
|
|
|
|||
|
|
## Installation
|
|||
|
|
|
|||
|
|
```
|
|||
|
|
npm install @11ty/eleventy --save-dev
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
Read our [Getting Started guide](https://www.11ty.dev/docs/getting-started/).
|
|||
|
|
|
|||
|
|
## Tests
|
|||
|
|
|
|||
|
|
```
|
|||
|
|
npm run test
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
- We use the [ava JavaScript test runner](https://github.com/avajs/ava) ([Assertions documentation](https://github.com/avajs/ava/blob/master/docs/03-assertions.md))
|
|||
|
|
- ℹ️ To keep tests fast, thou shalt try to avoid writing files in tests.
|
|||
|
|
- [Code Coverage Statistics](https://github.com/11ty/eleventy/blob/master/docs/coverage.md)
|
|||
|
|
- [Benchmark for Performance Regressions](https://github.com/11ty/eleventy-benchmark)
|
|||
|
|
|
|||
|
|
## Community Roadmap
|
|||
|
|
|
|||
|
|
- [Top Feature Requests](https://github.com/11ty/eleventy/issues?q=label%3Aneeds-votes+sort%3Areactions-%2B1-desc+label%3Aenhancement) (Add your own votes using the 👍 reaction)
|
|||
|
|
- [Documentation Requests](https://github.com/11ty/eleventy/issues?q=is%3Aissue+label%3Adocumentation+label%3Aneeds-votes+sort%3Areactions-%2B1-desc) (Add your own votes using the 👍 reaction)
|
|||
|
|
- [Top Bugs 😱](https://github.com/11ty/eleventy/issues?q=is%3Aissue+is%3Aopen+label%3Abug+sort%3Areactions-%2B1-desc) (Add your own votes using the 👍 reaction)
|
|||
|
|
- [Newest Bugs 🙀](https://github.com/11ty/eleventy/issues?q=is%3Aopen+is%3Aissue+label%3Abug)
|
|||
|
|
|
|||
|
|
## Plugins
|
|||
|
|
|
|||
|
|
See the [official docs on plugins](https://www.11ty.dev/docs/plugins/).
|