Apply Prettier to README.md

This commit is contained in:
Marcus Blättermann 2022-09-11 22:04:00 +02:00
parent f0d8309a28
commit 9d96e44a87
No known key found for this signature in database
GPG Key ID: A1E1F04008AC450D

View File

@ -555,13 +555,13 @@ extensions for your code editor. The
file in the root defines the settings used in this codebase. file in the root defines the settings used in this codebase.
## Building & developing the site with Docker {#docker} ## Building & developing the site with Docker {#docker}
Sometimes it's hard to get a local environment working due to rapid updates to node dependencies,
so it may be easier to use docker for building the docs.
If you'd like to do this, Sometimes it's hard to get a local environment working due to rapid updates to
**be sure you do *not* include your local `node_modules` folder**, node dependencies, so it may be easier to use docker for building the docs.
since there are some dependencies that need to be built for the image system.
Rename it before using. If you'd like to do this, **be sure you do _not_ include your local
`node_modules` folder**, since there are some dependencies that need to be built
for the image system. Rename it before using.
```bash ```bash
docker run -it \ docker run -it \
@ -571,13 +571,13 @@ docker run -it \
gatsby develop -H 0.0.0.0 gatsby develop -H 0.0.0.0
``` ```
This will allow you to access the built website at http://0.0.0.0:8000/ This will allow you to access the built website at http://0.0.0.0:8000/ in your
in your browser, and still edit code in your editor while having the site browser, and still edit code in your editor while having the site reflect those
reflect those changes. changes.
**Note**: If you're working on a Mac with an M1 processor, **Note**: If you're working on a Mac with an M1 processor, you might see
you might see segfault errors from `qemu` if you use the default image. segfault errors from `qemu` if you use the default image. To fix this use the
To fix this use the `arm64` tagged image in the `docker run` command `arm64` tagged image in the `docker run` command
(ghcr.io/explosion/spacy-io:arm64). (ghcr.io/explosion/spacy-io:arm64).
### Building the Docker image {#docker-build} ### Building the Docker image {#docker-build}
@ -588,7 +588,8 @@ If you'd like to build the image locally, you can do so like this:
docker build -t spacy-io . docker build -t spacy-io .
``` ```
This will take some time, so if you want to use the prebuilt image you'll save a bit of time. This will take some time, so if you want to use the prebuilt image you'll save a
bit of time.
## Markdown reference {#markdown} ## Markdown reference {#markdown}