Skip to content

Commit 9d4d3cd

Browse files
committed
docs(readme): optimize docs
1 parent 016e539 commit 9d4d3cd

1 file changed

Lines changed: 14 additions & 11 deletions

File tree

README.md

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,28 @@
11
# Vimhack/dotfiles 🍀
22

33
Vimhack/dotfiles is a Fantastic Development Environment,
4-
built with Vim/Neovim, Tmux, Zsh, Alacritty
4+
built with [Vim][1]/[Neovim][2], [Tmux][3], [Zsh](4), [Alacritty][5]
55
and many other related excellent open source softwares.
66

77
The supported platforms currently are macOS and Linux.
88

99
> For efficient and convenient use of shortcuts,
10-
> I strongly recommend using [HHKB](https://happyhackingkb.com/) keyboard,
10+
> I strongly recommend using [HHKB][6] keyboard,
1111
> or a keyboard capable of changing the key position and change <kbd>Caps</kbd> to <kbd>Ctrl</kbd>.
12+
> <br>
13+
> If you use MacBook, you can use [Karabiner-Elements][7]
14+
> to modify the <kbd>Caps</kbd> to left <kbd>Ctrl</kbd> easily.
15+
16+
[1]: https://github.com/vim/vim
17+
[2]: https://github.com/neovim/neovim
18+
[3]: https://github.com/tmux/tmux
19+
[4]: https://ohmyz.sh/
20+
[5]: https://github.com/alacritty/alacritty
21+
[6]: https://happyhackingkb.com/
22+
[7]: https://github.com/pqrs-org/Karabiner-Elements
1223

1324
## Contents
1425

15-
- [Powers](#Powers)
1626
- [Requirements Installation](#Requirements-Installation)
1727
- [Installation](#Installation)
1828
- [Colorscheme/Theme](#ColorschemeTheme)
@@ -189,13 +199,6 @@ The supported platforms currently are macOS and Linux.
189199
- [Show](#show)
190200
- [License](#License)
191201

192-
## 💝 <a name="powers"></a>Powers [](#Contents)
193-
194-
- [Vim](https://github.com/vim/vim) or [Neovim](https://github.com/neovim/neovim)
195-
- [Tmux](https://github.com/tmux/tmux)
196-
- [Zsh](https://ohmyz.sh/)
197-
- [Alacritty](https://github.com/alacritty/alacritty)
198-
199202
## 📦 <a name="Requirements-Installation"></a>Requirements Installation [](#Contents)
200203

201204
See [here](REQUIREMENTS.md).
@@ -1163,7 +1166,7 @@ pressing `,f` will jump the cursor to the placeholder and delete it at the same
11631166
- `,` `gd` : Show chunk diff at current position
11641167
- `,` `gc` : Show commit contains current position
11651168
- `<tab>` : Use tab for trigger completion with characters ahead and navigate
1166-
- `g` `l` : Go to definition position by create new tab way
1169+
- `g` `d`/`l` : Go to definition position by create new tab way
11671170
- `g` `y` : Go to type definition
11681171
- `g` `i` : Go to implementation position
11691172
- `g` `r` : Show related items in location list, and select one to go to

0 commit comments

Comments
 (0)