3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-05-10 07:37:19 +02:00
Code Issues Projects Releases Packages Wiki Activity

misc: add command to run prettier on docs (#2102)

Browse source 
* misc: add command to run prettier on docs

* Fix GH issue template

* Fix tests

* Add prettier-docs command to precommit
This commit is contained in:
Yangshun Tay 2019-12-07 21:56:30 -08:00 • committed by GitHub
parent cfc313d7c7
commit 55e676cb25
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
141 changed files with 1181 additions and 968 deletions
Download patch file Download diff file Expand all files Collapse all files

12
docs/getting-started-docker.md
View file

@ -13,13 +13,13 @@ To run the local web server:
1. **Build the docker image** -- Enter the folder where you have Docusaurus installed. Run `docker build -t docusaurus-doc .`
Once the build phase finishes, you can verify the image exists by running `docker images`.
Once the build phase finishes, you can verify the image exists by running `docker images`.
> We now include a `Dockerfile` when you install Docusaurus.
> We now include a `Dockerfile` when you install Docusaurus.
2. **Run the Docusaurus container** -- To start docker run `docker run --rm -p 3000:3000 docusaurus-doc`
This will start a docker container with the image `docusaurus-doc`. To see more detailed container info run `docker ps` .
This will start a docker container with the image `docusaurus-doc`. To see more detailed container info run `docker ps` .
## Use docker-compose
@ -36,8 +36,9 @@ Using Compose is a three-step process:
3. Run `docker-compose up` and Compose starts and runs your entire app.
We include a basic `docker-compose.yml` in your project:
``` yml
version: "3"
```yml
version: '3'
services:
docusaurus:
@ -55,7 +56,6 @@ services:
- ./website/sidebars.json:/app/website/sidebars.json
- ./website/siteConfig.js:/app/website/siteConfig.js
working_dir: /app/website
```
To run a local web server with `docker-compose` run `docker-compose up`.