summaryrefslogtreecommitdiff
path: root/node_modules/@11ty/eleventy/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/@11ty/eleventy/README.md')
-rw-r--r--node_modules/@11ty/eleventy/README.md47
1 files changed, 47 insertions, 0 deletions
diff --git a/node_modules/@11ty/eleventy/README.md b/node_modules/@11ty/eleventy/README.md
new file mode 100644
index 0000000..4b464b8
--- /dev/null
+++ b/node_modules/@11ty/eleventy/README.md
@@ -0,0 +1,47 @@
+<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, with addons for WebC, Sass, Vue, Svelte, TypeScript, JSX, and many others!
+
+## ➡ [Documentation](https://www.11ty.dev/docs/)
+
+- Please star [this repo on GitHub](https://github.com/11ty/eleventy/)!
+- Follow us on Mastodon [@eleventy@fosstodon.org](https://fosstodon.org/@eleventy) or Twitter [@eleven_ty](https://twitter.com/eleven_ty)
+- Join us on [Discord](https://www.11ty.dev/blog/discord/)
+- 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)
+
+[![npm Version](https://img.shields.io/npm/v/@11ty/eleventy.svg?style=for-the-badge)](https://www.npmjs.com/package/@11ty/eleventy) [![GitHub issues](https://img.shields.io/github/issues/11ty/eleventy.svg?style=for-the-badge)](https://github.com/11ty/eleventy/issues) [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=for-the-badge)](https://github.com/prettier/prettier) [![npm Downloads](https://img.shields.io/npm/dt/@11ty/eleventy.svg?style=for-the-badge)](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.
+- [Continuous Integration on GitHub Actions](https://github.com/11ty/eleventy/actions/workflows/ci.yml)
+- [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)
+- [Top Bugs 😱](https://github.com/11ty/eleventy/issues?q=is%3Aissue+is%3Aopen+label%3Abug+sort%3Areactions) (Add your own votes using the 👍 reaction)
+
+## Plugins
+
+See the [official docs on plugins](https://www.11ty.dev/docs/plugins/).