diff options
| author | Ryan <fauxpark@gmail.com> | 2021-07-30 23:47:34 +1000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-07-30 14:47:34 +0100 |
| commit | 8b39a3c48470ff95ba358dcb36c3c2f3b8e5a70f (patch) | |
| tree | 77bb1760457be78790dc46480a7668b8b85947a7 /docs/cli_commands.md | |
| parent | d93089d8eaffa4fc6d3c41fd513b005bc8ff6562 (diff) | |
| download | qmk_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/cli_commands.md')
| -rw-r--r-- | docs/cli_commands.md | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/docs/cli_commands.md b/docs/cli_commands.md index 581342093..4e27622c7 100644 --- a/docs/cli_commands.md +++ b/docs/cli_commands.md | |||
| @@ -349,11 +349,12 @@ qmk cformat -b branch_name | |||
| 349 | ## `qmk docs` | 349 | ## `qmk docs` |
| 350 | 350 | ||
| 351 | This command starts a local HTTP server which you can use for browsing or improving the docs. Default port is 8936. | 351 | This command starts a local HTTP server which you can use for browsing or improving the docs. Default port is 8936. |
| 352 | Use the `-b`/`--browser` flag to automatically open the local webserver in your default browser. | ||
| 352 | 353 | ||
| 353 | **Usage**: | 354 | **Usage**: |
| 354 | 355 | ||
| 355 | ``` | 356 | ``` |
| 356 | qmk docs [-p PORT] | 357 | qmk docs [-b] [-p PORT] |
| 357 | ``` | 358 | ``` |
| 358 | 359 | ||
| 359 | ## `qmk generate-docs` | 360 | ## `qmk generate-docs` |