57 lines
1.8 KiB
Markdown
57 lines
1.8 KiB
Markdown
<p align="center"><img src="https://www.11ty.dev/img/logo-github.svg" width="200" height="200" alt="11ty Logo"></p>
|
||
|
||
# eleventy-dev-server 🕚⚡️🎈🐀
|
||
|
||
A minimal, modern, generic, hot-reloading local web server to help web developers.
|
||
|
||
## ➡ [Documentation](https://www.11ty.dev/docs/watch-serve/#eleventy-dev-server)
|
||
|
||
- Please star [Eleventy 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)
|
||
|
||
[](https://www.npmjs.com/package/@11ty/eleventy-dev-server)
|
||
|
||
## Installation
|
||
|
||
This is bundled with `@11ty/eleventy` (and you do not need to install it separately) in Eleventy v2.0.
|
||
|
||
## CLI
|
||
|
||
Eleventy Dev Server now also includes a CLI. The CLI is for **standalone** (non-Eleventy) use only: separate installation is unnecessary if you’re using this server with `@11ty/eleventy`.
|
||
|
||
```sh
|
||
npm install -g @11ty/eleventy-dev-server
|
||
|
||
# Alternatively, install locally into your project
|
||
npm install @11ty/eleventy-dev-server
|
||
```
|
||
|
||
This package requires Node 14 or newer.
|
||
|
||
### CLI Usage
|
||
|
||
```sh
|
||
# Serve the current directory
|
||
npx @11ty/eleventy-dev-server
|
||
|
||
# Serve a different subdirectory (also aliased as --input)
|
||
npx @11ty/eleventy-dev-server --dir=_site
|
||
|
||
# Disable the `domdiff` feature
|
||
npx @11ty/eleventy-dev-server --domdiff=false
|
||
|
||
# Full command list in the Help
|
||
npx @11ty/eleventy-dev-server --help
|
||
```
|
||
|
||
## 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))
|