diff options
| author | fauxpark <fauxpark@gmail.com> | 2019-10-09 05:06:26 +1100 |
|---|---|---|
| committer | Drashna Jaelre <drashna@live.com> | 2019-10-08 11:06:26 -0700 |
| commit | 2707652c9877e5fc7dd67670f8e14962c31baf42 (patch) | |
| tree | fe59684ab5a80ed51bb14c5b465254c24935d194 /docs/cli.md | |
| parent | e7d95701bf12998a61c5d2143891b24939ebbe52 (diff) | |
| download | qmk_firmware-2707652c9877e5fc7dd67670f8e14962c31baf42.tar.gz qmk_firmware-2707652c9877e5fc7dd67670f8e14962c31baf42.zip | |
[Docs] CLI command to serve docs locally (#6956)
* CLI command to serve docs locally
* Document it
* Default port
* Use `with` and subclass `SimpleHTTPRequestHandler` to set working dir
* Apply suggestions from code review
Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com>
* Update docs/cli.md
Diffstat (limited to 'docs/cli.md')
| -rw-r--r-- | docs/cli.md | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/docs/cli.md b/docs/cli.md index 6ffe033653..d150ee917d 100644 --- a/docs/cli.md +++ b/docs/cli.md @@ -105,6 +105,16 @@ This command lets you configure the behavior of QMK. For the full `qmk config` d qmk config [-ro] [config_token1] [config_token2] [...] [config_tokenN] ``` +## `qmk docs` + +This command starts a local HTTP server which you can use for browsing or improving the docs. Default port is 8936. + +**Usage**: + +``` +qmk docs [-p PORT] +``` + ## `qmk doctor` This command examines your environment and alerts you to potential build or flash problems. |