Skip to content

Commit

Permalink
docs(keybinds): add instructions for Alacritty key setting (LunarVim#404
Browse files Browse the repository at this point in the history
)
  • Loading branch information
bartvanraaij authored May 17, 2023
1 parent dedb1e0 commit 9700792
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 5 deletions.
2 changes: 1 addition & 1 deletion .github/actions/spelling/expect.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
Alacritty
autoclose
autorename
autoselect
Expand Down Expand Up @@ -32,7 +33,6 @@ scrolloff
stoggleup
strlist
tabpage
tmux
todo
tokyonight
uelic
Expand Down
6 changes: 4 additions & 2 deletions docs/beginners-guide/keybinds-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,11 @@ Also see:

**TIP:** `<leader>` is space by default, read [`:help keycodes`](https://neovim.io/doc/user/intro.html#keycodes) for more key names

**TIP:** `<M>` is `alt` on Windows/Linux and `option` on MacOS
**TIP:** `<M>` is `alt` on Windows/Linux and `option` on macOS

**TIP:** If you happen to be using iTerm2, take note that `<M>` requires the `option` key to be mapped to `Esc+` in [ Preferences - Profiles - Keys ](https://github.com/LunarVim/lunarvim.org/pull/377#discussion_r1140747022) for proper functioning in both the terminal and tmux
**TIP:** For macOS users: For the `option` key (``) to work as `<M>` you may need to adjust some settings:
- For iTerm2: Select `Esc+` as the Option key setting in [ Preferences - Profiles - Keys ](https://github.com/LunarVim/lunarvim.org/pull/377#discussion_r1140747022)
- For Alacritty: Make sure you're on Alacritty version >= 0.12.0. In your `alacritty.yml` config file, set `window.option_as_alt` to `Both` or `OnlyLeft` \ `OnlyRight` per your preference (https://github.com/alacritty/alacritty/issues/62).

**TIP:** Non-leader keybindings (for e.g. `<C-\>`, mentioned below and others) can be viewed
by pressing `<backspace>` in the which-key main menu (first popup after pressing `<leader>`)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,11 @@ Also see:

**TIP:** `<leader>` is space by default, read [`:help keycodes`](https://neovim.io/doc/user/intro.html#keycodes) for more key names

**TIP:** `<M>` is `alt` on Windows/Linux and `option` on MacOS
**TIP:** `<M>` is `alt` on Windows/Linux and `option` on macOS

**TIP:** If you happen to be using iTerm2, take note that `<M>` requires the `option` key to be mapped to `Esc+` in [ Preferences - Profiles - Keys ](https://github.com/LunarVim/lunarvim.org/pull/377#discussion_r1140747022) for proper functioning in both the terminal and tmux
**TIP:** For macOS users: For the `option` key (``) to work as `<M>` you may need to adjust some settings:
- For iTerm2: Select `Esc+` as the Option key setting in [ Preferences - Profiles - Keys ](https://github.com/LunarVim/lunarvim.org/pull/377#discussion_r1140747022)
- For Alacritty: Make sure you're on Alacritty version >= 0.12.0. In your `alacritty.yml` config file, set `window.option_as_alt` to `Both` or `OnlyLeft` \ `OnlyRight` per your preference (https://github.com/alacritty/alacritty/issues/62).

**TIP:** Non-leader keybindings (for e.g. `<C-\>`, mentioned below and others) can be viewed
by pressing `<backspace>` in the which-key main menu (first popup after pressing `<leader>`)
Expand Down

0 comments on commit 9700792

Please sign in to comment.