Skip to content

Commit

Permalink
update shortcuts help
Browse files Browse the repository at this point in the history
  • Loading branch information
tamlok committed Jun 23, 2017
1 parent 4e15405 commit 140c731
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 4 deletions.
24 changes: 22 additions & 2 deletions src/resources/docs/shortcuts_en.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
2. On macOS, `Ctrl` corresponds to `Command`;

## Normal Shortcuts
- `Ctrl+T`
- `Ctrl+E E`
Toggle expanding the edit area.
- `Ctrl+N`
Create a note in current directory.
Expand All @@ -13,6 +13,8 @@ Find/Replace in current note.
Quit VNote.
- `Ctrl+J`/`Ctrl+K`
VNote supports `Ctrl+J` and `Ctrl+K` for navigation in the notebooks list, directories list, notes list, opened notes list, and outline list.
- `Ctrl+Left Mouse`
Scroll in all directions.

### Read Mode
- `Ctrl+W`
Expand All @@ -35,7 +37,7 @@ Recover the page zoom factor to 100%.
### Edit Mode
- `Ctrl+S`
Save current changes.
- `Ctrl+R`
- `Ctrl+T`
Save current changes and exit edit mode.

#### Text Editing
Expand Down Expand Up @@ -112,3 +114,21 @@ Display shortcuts documentation.

## Navigation Mode
Within the Captain MOde, `W` will turn VNote into **Navigation Mode**. In this mode, VNote will display at most two characters on some major widgets, and then pressing corresponding characters will jump to that widget.

## Vim Mode
VNote supports a simple but useful Vim mode, including **Normal**, **Insert**, **Visual**, and **VisualLine** modes.

VNote supports following features of Vim:

- `d`, `c`, `y`, `p`, `<`, `>`, `gu`, `gU` actions;
- Marks `a-z`;
- Registers `"`, `_`, `+`, `a-z`(`A-Z`);
- Jump locations list (`Ctrl+O` and `Ctrl+I`);
- Leader key
- Currently `<leader>y/d/p` equals to `"+y/d/p`, which will access the system's clipboard.
- `zz`, `zb`, `zt`;
- `u` and `Ctrl+R` for undo and redo;

For now, VNote does **NOT** support the macro and repeat(`.`) features of Vim.

Enjoy Vim on VNote!
23 changes: 21 additions & 2 deletions src/resources/docs/shortcuts_zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
2. 在macOS下,`Ctrl`对应于`Command`

## 常规快捷键
- `Ctrl+T`
- `Ctrl+E E`
是否扩展编辑区域。
- `Ctrl+N`
在当前文件夹下新建笔记。
Expand All @@ -13,6 +13,8 @@
退出VNote。
- `Ctrl+J`/`Ctrl+K`
在笔记本列表、文件夹列表、笔记列表、已打开笔记列表和大纲目录中,均支持`Ctrl+J``Ctrl+K`导航。
- `Ctrl+Left Mouse`
任意滚动。

### 阅读模式
- `Ctrl+W`
Expand All @@ -35,7 +37,7 @@
### 编辑模式
- `Ctrl+S`
保存当前更改。
- `Ctrl+R`
- `Ctrl+T`
保存当前更改并退出编辑模式。

#### 文本编辑
Expand Down Expand Up @@ -113,3 +115,20 @@
## 展览模式
在舰长模式中,`W`命令会进入 **展览模式**。在展览模式中,VNote会在常用的主要部件上显示至多两个字母,此时输入对应的字母即可跳转到该部件中,从而实现快速切换焦点并触发功能。

## Vim Mode
VNote支持一个简单但有用的Vim模式,包括 **正常****插入****可视****可视行** 模式。

VNote支持以下几个Vim的特性:

- `d`, `c`, `y`, `p`, `<`, `>`, `gu`, `gU` 操作;
- 标记 `a-z`
- 寄存器 `"`, `_`, `+`, `a-z`(`A-Z`);
- 跳转位置列表 (`Ctrl+O` and `Ctrl+I`);
- 前导键
- 目前 `<leader>y/d/p` 等同于 `"+y/d/p`, 从而可以访问系统剪切板。
- `zz`, `zb`, `zt`;
- `u``Ctrl+R` 撤销和重做;

VNote目前暂时不支持Vim的宏和重复(`.`)特性。

在VNote上享受Vim的美好时光吧!

0 comments on commit 140c731

Please sign in to comment.