From 9951df77097b30d096e993c34243af6ce35cdcf9 Mon Sep 17 00:00:00 2001 From: Nate Butler Date: Tue, 20 Aug 2024 11:23:40 -0400 Subject: [PATCH] Update some docs keybindings to new format (#16524) Updates some of the docs pages to the new keybinding format. Release Notes: - N/A --- docs/src/configuring-languages.md | 14 +++++++------- docs/src/configuring-zed.md | 2 +- docs/src/getting-started.md | 12 +++++------- 3 files changed, 13 insertions(+), 15 deletions(-) diff --git a/docs/src/configuring-languages.md b/docs/src/configuring-languages.md index d8d1860f61be3c863345f3b5dacf10de45b2d96e..7305e1d472a7ac808e332c628c49660077c37800 100644 --- a/docs/src/configuring-languages.md +++ b/docs/src/configuring-languages.md @@ -336,7 +336,7 @@ This configuration changes the color of function names in Python files. Change your theme: -1. Use the theme selector (Cmd+K Cmd+T on macOS, Ctrl+K Ctrl+T on Linux) +1. Use the theme selector (cmd-k cmd-t|ctrl-k ctrl-t) 2. Or set it in your `settings.json`: ```json @@ -351,7 +351,7 @@ Create custom themes by creating a JSON file in `~/.config/zed/themes/`. Zed wil ### Using Theme Extensions -Zed supports theme extensions. Browse and install theme extensions from the Extensions panel (Cmd+Shift+E). +Zed supports theme extensions. Browse and install theme extensions from the Extensions panel (cmd-shift-e|ctrl-shift-e). To create your own theme extension, refer to the [Developing Theme Extensions](./extensions/themes.md) guide. @@ -380,16 +380,16 @@ Code actions provide quick fixes and refactoring options. Access code actions us Use these commands to navigate your codebase: -- `editor: Go to Definition` (F12) -- `editor: Go to Type Definition` (Cmd+F12 on macOS, Ctrl+F12 on Linux) -- `editor: Find All References` (Shift+F12) +- `editor: Go to Definition` (f12|f12) +- `editor: Go to Type Definition` (cmd-f12|ctrl-f12) +- `editor: Find All References` (shift-f12|shift-f12) ### Rename Symbol To rename a symbol across your project: 1. Place your cursor on the symbol -2. Use the `editor: Rename Symbol` command (F2) +2. Use the `editor: Rename Symbol` command (f2|f2) 3. Enter the new name and press Enter These features depend on the capabilities of the language server for each language. @@ -406,7 +406,7 @@ The `workspace: Open Symbol` command allows you to search for symbols (functions ### Code Completion -Zed provides intelligent code completion suggestions as you type. You can manually trigger completion with the `editor: Show Completions` command. Use Tab or Enter to accept suggestions. +Zed provides intelligent code completion suggestions as you type. You can manually trigger completion with the `editor: Show Completions` command. Use tab|tab or enter|enter to accept suggestions. ### Diagnostics diff --git a/docs/src/configuring-zed.md b/docs/src/configuring-zed.md index f839f03420492c86e7b83543b3fe794f1f1efd4c..048f81dccf0eed5dbeb1dde4c4c87930ee881171 100644 --- a/docs/src/configuring-zed.md +++ b/docs/src/configuring-zed.md @@ -13,7 +13,7 @@ Consider renaming `zed: Open Local Settings` to `zed: Open Project Settings`. TBD: Add settings documentation about how settings are merged as overlays. E.g. project>local>default. Note how settings that are maps are merged, but settings that are arrays are replaced and must include the defaults. --> -Your settings file can be opened with `cmd-,` (on macOS) or `ctrl-,` (on Linux). By default it is located at `~/.config/zed/settings.json`, though if you have XDG_CONFIG_HOME in your environment on Linux it will be at `$XDG_CONFIG_HOME/zed/settings.json` instead. +Your settings file can be opened with cmd-,|ctrl-,. By default it is located at `~/.config/zed/settings.json`, though if you have XDG_CONFIG_HOME in your environment on Linux it will be at `$XDG_CONFIG_HOME/zed/settings.json` instead. This configuration is merged with any local configuration inside your projects. You can open the project settings by running `zed: Open Local Settings` from the command palette. This will create a `.zed` directory containing`.zed/settings.json`. diff --git a/docs/src/getting-started.md b/docs/src/getting-started.md index c1add5233b1c64d971a1e104122fbbffd27d5197..c032662ca30fc3ab91766881a4f444f9e24fb5c2 100644 --- a/docs/src/getting-started.md +++ b/docs/src/getting-started.md @@ -42,9 +42,7 @@ If this script is insufficient for your use case or you run into problems runnin The Command Palette is the main way to access functionality in Zed, and its keybinding is the first one you should make yourself familiar with. -On macOS, use `⌘-P` (`cmd-shift-p`) to open the Command Palette. - -On Linux, use `⌃-P` (`ctrl-shift-p`) to open the Command Palette. +To open the Command Palette, use cmd-shift-p|ctrl-shift-p. The Command Palette allows you to access pretty much any functionality that's available in Zed. @@ -56,14 +54,14 @@ Any time you see instructions that include commands of the form `zed: ...` or `e ## Configure Zed -Use `⌘` + `,`, or `ctrl` - `,` to open your custom settings to set things like fonts, formatting settings, per-language settings, and more. +Use cmd-,|ctrl-, to open your custom settings to set things like fonts, formatting settings, per-language settings, and more. On macOS, you can access the default configuration using the `Zed > Settings > Open Default Settings` menu item. See [Configuring Zed](./configuring-zed.md) for all available settings. -On Linux, you can access the default configuration via the Command Palette. Open it with `ctrl-shift-p` and type in `zed: open default settings` and then hit return. +On Linux, you can access the default configuration via the Command Palette. Open it with ctrl-shift-p and type in `zed: open default settings` and then hit return. ## Set up your key bindings -On macOS, you can access the default key binding set using the `Zed > Settings > Open Default Key Bindings` menu item. Use `⌘` + `K`, `⌘` + `S` to open your custom keymap to add your key bindings. See Key Bindings for more info. +On macOS, you can access the default key binding set using the `Zed > Settings > Open Default Key Bindings` menu item. Use cmd-k cmd-s|ctrl-k ctrl-s to open your custom keymap to add your key bindings. See Key Bindings for more info. -On Linux, you can access the default key bindings via the Command Palette. Open it with `ctrl-shift-p` and type in `zed: open default keymap` and then hit return. +On Linux, you can access the default key bindings via the Command Palette. Open it with ctrl-shift-p and type in `zed: open default keymap` and then hit return.