summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorRyan <fauxpark@gmail.com>2021-07-30 23:47:34 +1000
committerGitHub <noreply@github.com>2021-07-30 14:47:34 +0100
commit8b39a3c48470ff95ba358dcb36c3c2f3b8e5a70f (patch)
tree77bb1760457be78790dc46480a7668b8b85947a7 /docs
parentd93089d8eaffa4fc6d3c41fd513b005bc8ff6562 (diff)
downloadqmk_firmware-8b39a3c48470ff95ba358dcb36c3c2f3b8e5a70f.tar.gz
qmk_firmware-8b39a3c48470ff95ba358dcb36c3c2f3b8e5a70f.zip
`qmk docs`: Add flag to open in browser (#13788)
* `qmk docs`: Add flag to open in browser * Add docs
Diffstat (limited to 'docs')
-rw-r--r--docs/cli_commands.md3
1 files changed, 2 insertions, 1 deletions
diff --git a/docs/cli_commands.md b/docs/cli_commands.md
index 581342093a..4e27622c74 100644
--- a/docs/cli_commands.md
+++ b/docs/cli_commands.md
@@ -349,11 +349,12 @@ qmk cformat -b branch_name
## `qmk docs`
This command starts a local HTTP server which you can use for browsing or improving the docs. Default port is 8936.
+Use the `-b`/`--browser` flag to automatically open the local webserver in your default browser.
**Usage**:
```
-qmk docs [-p PORT]
+qmk docs [-b] [-p PORT]
```
## `qmk generate-docs`