diff options
| author | Joel Challis <git@zvecr.com> | 2024-05-30 10:00:28 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-05-30 10:00:28 +0100 |
| commit | b39285807e1d21300e8a5dbbf6f2c43a8aab3494 (patch) | |
| tree | 311895a73c967f5d322885c1a9f1073a7b9f1b91 /docs/cli_commands.md | |
| parent | 6ef97172889ccd5db376b2a9f8825489e24fdac4 (diff) | |
[docs] Fix code blocks overflowing page width (#23829)
Fix code blocks overflowing page width
Diffstat (limited to 'docs/cli_commands.md')
| -rw-r--r-- | docs/cli_commands.md | 58 |
1 files changed, 43 insertions, 15 deletions
diff --git a/docs/cli_commands.md b/docs/cli_commands.md index 6f82d9c9de..5a85356e70 100644 --- a/docs/cli_commands.md +++ b/docs/cli_commands.md | |||
| @@ -254,15 +254,21 @@ qmk doctor [-y] [-n] | |||
| 254 | 254 | ||
| 255 | Check your environment for problems and prompt to fix them: | 255 | Check your environment for problems and prompt to fix them: |
| 256 | 256 | ||
| 257 | qmk doctor | 257 | ``` |
| 258 | qmk doctor | ||
| 259 | ``` | ||
| 258 | 260 | ||
| 259 | Check your environment and automatically fix any problems found: | 261 | Check your environment and automatically fix any problems found: |
| 260 | 262 | ||
| 261 | qmk doctor -y | 263 | ``` |
| 264 | qmk doctor -y | ||
| 265 | ``` | ||
| 262 | 266 | ||
| 263 | Check your environment and report problems only: | 267 | Check your environment and report problems only: |
| 264 | 268 | ||
| 265 | qmk doctor -n | 269 | ``` |
| 270 | qmk doctor -n | ||
| 271 | ``` | ||
| 266 | 272 | ||
| 267 | ## `qmk format-json` | 273 | ## `qmk format-json` |
| 268 | 274 | ||
| @@ -290,15 +296,21 @@ This command is directory aware. It will automatically fill in KEYBOARD and/or K | |||
| 290 | 296 | ||
| 291 | Show basic information for a keyboard: | 297 | Show basic information for a keyboard: |
| 292 | 298 | ||
| 293 | qmk info -kb planck/rev5 | 299 | ``` |
| 300 | qmk info -kb planck/rev5 | ||
| 301 | ``` | ||
| 294 | 302 | ||
| 295 | Show the matrix for a keyboard: | 303 | Show the matrix for a keyboard: |
| 296 | 304 | ||
| 297 | qmk info -kb ergodox_ez -m | 305 | ``` |
| 306 | qmk info -kb ergodox_ez -m | ||
| 307 | ``` | ||
| 298 | 308 | ||
| 299 | Show a JSON keymap for a keyboard: | 309 | Show a JSON keymap for a keyboard: |
| 300 | 310 | ||
| 301 | qmk info -kb clueboard/california -km default | 311 | ``` |
| 312 | qmk info -kb clueboard/california -km default | ||
| 313 | ``` | ||
| 302 | 314 | ||
| 303 | ## `qmk json2c` | 315 | ## `qmk json2c` |
| 304 | 316 | ||
| @@ -350,7 +362,9 @@ This command is directory aware. It will automatically fill in KEYBOARD and/or K | |||
| 350 | 362 | ||
| 351 | Do a basic lint check: | 363 | Do a basic lint check: |
| 352 | 364 | ||
| 353 | qmk lint -kb rominronin/katana60/rev2 | 365 | ``` |
| 366 | qmk lint -kb rominronin/katana60/rev2 | ||
| 367 | ``` | ||
| 354 | 368 | ||
| 355 | ## `qmk list-keyboards` | 369 | ## `qmk list-keyboards` |
| 356 | 370 | ||
| @@ -789,16 +803,22 @@ qmk pytest [-t TEST] | |||
| 789 | 803 | ||
| 790 | Run entire test suite: | 804 | Run entire test suite: |
| 791 | 805 | ||
| 792 | qmk pytest | 806 | ``` |
| 807 | qmk pytest | ||
| 808 | ``` | ||
| 793 | 809 | ||
| 794 | Run test group: | 810 | Run test group: |
| 795 | 811 | ||
| 796 | qmk pytest -t qmk.tests.test_cli_commands | 812 | ``` |
| 813 | qmk pytest -t qmk.tests.test_cli_commands | ||
| 814 | ``` | ||
| 797 | 815 | ||
| 798 | Run single test: | 816 | Run single test: |
| 799 | 817 | ||
| 800 | qmk pytest -t qmk.tests.test_cli_commands.test_c2json | 818 | ``` |
| 801 | qmk pytest -t qmk.tests.test_qmk_path | 819 | qmk pytest -t qmk.tests.test_cli_commands.test_c2json |
| 820 | qmk pytest -t qmk.tests.test_qmk_path | ||
| 821 | ``` | ||
| 802 | 822 | ||
| 803 | ## `qmk painter-convert-graphics` | 823 | ## `qmk painter-convert-graphics` |
| 804 | 824 | ||
| @@ -835,16 +855,24 @@ options: | |||
| 835 | 855 | ||
| 836 | Run entire test suite: | 856 | Run entire test suite: |
| 837 | 857 | ||
| 838 | qmk test-c | 858 | ``` |
| 859 | qmk test-c | ||
| 860 | ``` | ||
| 839 | 861 | ||
| 840 | List available tests: | 862 | List available tests: |
| 841 | 863 | ||
| 842 | qmk test-c --list | 864 | ``` |
| 865 | qmk test-c --list | ||
| 866 | ``` | ||
| 843 | 867 | ||
| 844 | Run matching test: | 868 | Run matching test: |
| 845 | 869 | ||
| 846 | qmk test-c --test unicode* | 870 | ``` |
| 871 | qmk test-c --test unicode* | ||
| 872 | ``` | ||
| 847 | 873 | ||
| 848 | Run single test: | 874 | Run single test: |
| 849 | 875 | ||
| 850 | qmk test-c --test basic | 876 | ``` |
| 877 | qmk test-c --test basic | ||
| 878 | ``` | ||
