From 1bc1762b02b2b55c824ffc550d3c9efdb9aff7f1 Mon Sep 17 00:00:00 2001 From: Tan Li Hau Date: Mon, 15 Oct 2018 03:28:50 +0800 Subject: [PATCH] docs: document process.env.BROWSER for start command (#1034) * docs: document BROWSER * Update api-commands.md --- docs/api-commands.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/api-commands.md b/docs/api-commands.md index c9bf50dc1c..3a43fb60ca 100644 --- a/docs/api-commands.md +++ b/docs/api-commands.md @@ -140,13 +140,19 @@ See the [Versioning guide](guides-versioning.md#renaming-existing-versions) to l 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 | | ----------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------ | | `--port ` | `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`. | +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 `