diff options
| author | Ryan <fauxpark@gmail.com> | 2025-02-01 21:19:30 +1100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2025-02-01 21:19:30 +1100 |
| commit | 273d8d6a1a6badb8d9b473954f16a0fbbe671987 (patch) | |
| tree | 0d2558d1d8ae2ce22c5b6702abc5315c607e2c12 /docs/cli_commands.md | |
| parent | ff09b921f1c2160abe05c1fdbd38f25f64b6c7bd (diff) | |
`qmk docs`: restore `--port` and `--browser` arguments (#24623)
* `qmk docs`: restore `--port` and `--browser` arguments
* Make docs command args always a list
Diffstat (limited to 'docs/cli_commands.md')
| -rw-r--r-- | docs/cli_commands.md | 15 |
1 files changed, 9 insertions, 6 deletions
diff --git a/docs/cli_commands.md b/docs/cli_commands.md index 4cd5ae98c3..d17b0eda23 100644 --- a/docs/cli_commands.md +++ b/docs/cli_commands.md | |||
| @@ -723,23 +723,26 @@ Now open your dev environment and live a squiggly-free life. | |||
| 723 | 723 | ||
| 724 | ## `qmk docs` | 724 | ## `qmk docs` |
| 725 | 725 | ||
| 726 | This command starts a local HTTP server which you can use for browsing or improving the docs. Default port is 5173. | 726 | This command starts a local HTTP server which you can use for browsing or improving the docs, and provides live reload capability whilst editing. Default port is 8936. |
| 727 | Use the `-b`/`--browser` flag to automatically open the local webserver in your default browser. | ||
| 727 | 728 | ||
| 728 | This command requires `node` and `yarn` to be installed as prerequisites, and provides live reload capability whilst editing. | 729 | Requires `node` and `yarn` to be installed as prerequisites. |
| 729 | 730 | ||
| 730 | **Usage**: | 731 | **Usage**: |
| 731 | 732 | ||
| 732 | ``` | 733 | ``` |
| 733 | usage: qmk docs [-h] | 734 | usage: qmk docs [-h] [-b] [-p PORT] |
| 734 | 735 | ||
| 735 | options: | 736 | options: |
| 736 | -h, --help show this help message and exit | 737 | -h, --help show this help message and exit |
| 738 | -b, --browser Open the docs in the default browser. | ||
| 739 | -p, --port PORT Port number to use. | ||
| 737 | ``` | 740 | ``` |
| 738 | 741 | ||
| 739 | ## `qmk generate-docs` | 742 | ## `qmk generate-docs` |
| 740 | 743 | ||
| 741 | This command allows you to generate QMK documentation locally. It can be uses for general browsing or improving the docs. | 744 | This command generates QMK documentation for production. |
| 742 | Use the `-s`/`--serve` flag to also serve the static site once built. Default port is 4173. | 745 | Use the `-s`/`--serve` flag to also serve the static site on port 4173 once built. Note that this does not provide live reloading; use `qmk docs` instead for development purposes. |
| 743 | 746 | ||
| 744 | This command requires `node` and `yarn` to be installed as prerequisites, and requires the operating system to support symlinks. | 747 | This command requires `node` and `yarn` to be installed as prerequisites, and requires the operating system to support symlinks. |
| 745 | 748 | ||
