diff options
Diffstat (limited to 'docs/cli_commands.md')
| -rw-r--r-- | docs/cli_commands.md | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/docs/cli_commands.md b/docs/cli_commands.md index b10f5d499..69df82f95 100644 --- a/docs/cli_commands.md +++ b/docs/cli_commands.md | |||
| @@ -286,6 +286,16 @@ This command starts a local HTTP server which you can use for browsing or improv | |||
| 286 | qmk docs [-p PORT] | 286 | qmk docs [-p PORT] |
| 287 | ``` | 287 | ``` |
| 288 | 288 | ||
| 289 | ## `qmk generate-docs` | ||
| 290 | |||
| 291 | This command allows you to generate QMK documentation locally. It can be uses for general browsing or improving the docs. External tools such as [serve](https://www.npmjs.com/package/serve) can be used to browse the generated files. | ||
| 292 | |||
| 293 | **Usage**: | ||
| 294 | |||
| 295 | ``` | ||
| 296 | qmk generate-docs | ||
| 297 | ``` | ||
| 298 | |||
| 289 | ## `qmk kle2json` | 299 | ## `qmk kle2json` |
| 290 | 300 | ||
| 291 | This command allows you to convert from raw KLE data to QMK Configurator JSON. It accepts either an absolute file path, or a file name in the current directory. By default it will not overwrite `info.json` if it is already present. Use the `-f` or `--force` flag to overwrite. | 301 | This command allows you to convert from raw KLE data to QMK Configurator JSON. It accepts either an absolute file path, or a file name in the current directory. By default it will not overwrite `info.json` if it is already present. Use the `-f` or `--force` flag to overwrite. |
