jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-19 18:10:59 -05:00
Code Issues Projects Releases Wiki Activity

[Feb 3] Add keyboard shortcut customization to command palette docs (#24293)

Browse Source 
* Update github-command-palette.md
er01@users.noreply.github.com>
This commit is contained in:
Garrett Knoll
2022-02-03 11:50:45 -05:00
committed by GitHub
parent c5f9788223
commit f238e8b9e6
2 changed files with 13 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
content/get-started/using-github/github-command-palette.md
View File

@@ -26,10 +26,12 @@ The ability to run commands directly from your keyboard, without navigating thro
## Opening the {% data variables.product.prodname_command_palette %}
Open the command palette using one of the following keyboard shortcuts:
Open the command palette using one of the following default keyboard shortcuts:
- Windows and Linux: <kbd>Ctrl</kbd>+<kbd>K</kbd> or <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>K</kbd>
- Mac: <kbd>Command</kbd>+<kbd>K</kbd> or <kbd>Command</kbd>+<kbd>Option</kbd>+<kbd>K</kbd>
You can customize the keyboard shortcuts you use to open the command palette in the [Accessibility section](https://github.com/settings/accessibility) of your user settings. For more information, see "[Customizing your {% data variables.product.prodname_command_palette %} keyboard shortcuts](#customizing-your-github-command-palette-keyboard-shortcuts)."
When you open the command palette, it shows your location at the top left and uses it as the scope for suggestions (for example, the `mashed-avocado` organization).
![Command palette launch](/assets/images/help/command-palette/command-palette-launch.png)
@@ -42,6 +44,12 @@ When you open the command palette, it shows your location at the top left and us
{% endnote %}
### Customizing your {% data variables.product.prodname_command_palette %} keyboard shortcuts
The default keyboard shortcuts used to open the command palette may conflict with your default OS and browser keyboard shortcuts. You have the option to customize your keyboard shortcuts in the [Accessibility section](https://github.com/settings/accessibility) of your account settings. In the command palette settings, you can customize the keyboard shortcuts for opening the command palette in both search mode and command mode.
![Command palette keyboard shortcut settings](/assets/images/help/command-palette/command-palette-keyboard-shortcut-settings.png)
## Navigating with the {% data variables.product.prodname_command_palette %}
You can use the command palette to navigate to any page that you have access to on {% data variables.product.product_name %}.
@@ -96,7 +104,7 @@ You can use the {% data variables.product.prodname_command_palette %} to run com
For a full list of supported commands, see "[{% data variables.product.prodname_command_palette %} reference](#github-command-palette-reference)."
1. Use <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>K</kbd> (Windows and Linux) or <kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>K</kbd> (Mac) to open the command palette in command mode. If you already have the command palette open, press <kbd>></kbd> to switch to command mode. {% data variables.product.prodname_dotcom %} suggests commands based on your location.
1. The default keyboard shortcuts to open the command palette in command mode are <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>K</kbd> (Windows and Linux) or <kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>K</kbd> (Mac). If you already have the command palette open, press <kbd>></kbd> to switch to command mode. {% data variables.product.prodname_dotcom %} suggests commands based on your location.
![Command palette command mode](/assets/images/help/command-palette/command-palette-command-mode.png)
@@ -106,6 +114,7 @@ For a full list of supported commands, see "[{% data variables.product.prodname_
4. Use the arrow keys to highlight the command you want and use <kbd>Enter</kbd> to run it.
## Closing the command palette
When the command palette is active, you can use one of the following keyboard shortcuts to close the command palette:
@@ -113,6 +122,8 @@ When the command palette is active, you can use one of the following keyboard sh
- Search and navigation mode: <kbd>Esc</kbd> or <kbd>Ctrl</kbd>+<kbd>K</kbd> (Windows and Linux) <kbd>Command</kbd>+<kbd>K</kbd> (Mac)
- Command mode: <kbd>Esc</kbd> or <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>K</kbd> (Windows and Linux) <kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>K</kbd> (Mac)
If you have customized the command palette keyboard shortcuts in the Accessibility settings, your customized keyboard shortcuts will be used for both opening and closing the command palette.
## {% data variables.product.prodname_command_palette %} reference
### Keystroke functions