summaryrefslogtreecommitdiff
path: root/docs/cli_commands.md
diff options
context:
space:
mode:
authorRyan <fauxpark@gmail.com>2021-11-05 08:02:27 +1100
committerGitHub <noreply@github.com>2021-11-05 08:02:27 +1100
commit6437045166cafab14f2fbe5fcae44f6b066adbc5 (patch)
treeb774d69b5ae926b9c5cf583a95fe28c8c39942f6 /docs/cli_commands.md
parentc85109b1089b646641ec28e81d9530b8d1d0f263 (diff)
downloadqmk_firmware-6437045166cafab14f2fbe5fcae44f6b066adbc5.tar.gz
qmk_firmware-6437045166cafab14f2fbe5fcae44f6b066adbc5.zip
`qmk docs`: Run `docsify serve` if available (#15056)
Diffstat (limited to 'docs/cli_commands.md')
-rw-r--r--docs/cli_commands.md2
1 files changed, 2 insertions, 0 deletions
diff --git a/docs/cli_commands.md b/docs/cli_commands.md
index 8fa7ad41dc..e498f3b22e 100644
--- a/docs/cli_commands.md
+++ b/docs/cli_commands.md
@@ -373,6 +373,8 @@ qmk format-c -b branch_name
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.
+This command runs `docsify serve` if `docsify-cli` is installed (which provides live reload), otherwise Python's builtin HTTP server module will be used.
+
**Usage**:
```