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

docs: document process.env.BROWSER for start command (#1034)

Browse source 
* docs: document BROWSER

* Update api-commands.md
This commit is contained in:
Tan Li Hau 2018-10-15 03:28:50 +08:00 • committed by Yangshun Tay
parent 287c4872fe
commit 1bc1762b02
1 changed files with 7 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

8
docs/api-commands.md
View file

@ -140,13 +140,19 @@ See the [Versioning guide](guides-versioning.md#renaming-existing-versions) to l
Alias: `start`. Alias: `start`.
This script will build the static website, apply translations if necessary, and then start a local server. This command will build the static website, apply translations if necessary, and then start a local server.
| Options | Default | Description | | Options | Default | Description |
| ----------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------ | | ----------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| `--port <number>` | `3000` | The website will be served from port 3000 by default, but if the port is taken up, Docusaurus will attempt to find an available one. | | `--port <number>` | `3000` | The website will be served from port 3000 by default, but if the port is taken up, Docusaurus will attempt to find an available one. |
| `--watch` | - | Whether to watch the files and live reload the page when files are changed. Defaults to true. Disable this by using `--no-watch`. | | `--watch` | - | Whether to watch the files and live reload the page when files are changed. Defaults to true. Disable this by using `--no-watch`. |
You can specify the browser application to be opened by setting the `BROWSER` environment variable before the command, e.g.:
```
$ BROWSER=firefox yarn start
```
--- ---
### `docusaurus-version <version>` ### `docusaurus-version <version>`