Add additional parameters for Docker usage example

This commit is contained in:
Matthias 2022-01-27 12:43:34 +01:00 committed by GitHub
parent 54551d6184
commit 04f9b7c23b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -175,10 +175,12 @@ acat -F zip {file.epub} "*.xhtml" "*.html" | lychee -
### Docker Usage
Here's how to mount a local directory into the container and check some input
with lychee:
with lychee. The `--init` parameter is passed so that lychee can be stopped
from the terminal. We also pass `-it` to start an interactive terminal, which
is required to show the progress bar.
```sh
docker run -v `pwd`:/input lycheeverse/lychee /input/README.md
docker run --init -it -v `pwd`:/input lycheeverse/lychee /input/README.md
```
### GitHub Token