# Quick Nav

English | [中文](./README.zh-cn.md) | [日本語](./README.ja.md)

Enhance your editing experience by unleashing the hidden power of shortcuts. 

## Usage

Quick Nav exposes powerful navigation operations without binding default shortcuts. This gives you the freedom to customize your editing experience according to your preferences.

Below are our **recommended shortcut bindings** that you can set up in Obsidian's Hotkeys settings:

### Recommended Cursor Movement Shortcuts

-   **Move Cursor Up**: `Alt + I` (Windows/Linux), `Ctrl + I` (MacOS)
-   **Move Cursor Down**: `Alt + K` (Windows/Linux), `Ctrl + K` (MacOS)
-   **Move Cursor Left**: `Alt + J` (Windows/Linux), `Ctrl + J` (MacOS)
-   **Move Cursor Right**: `Alt + L` (Windows/Linux), `Ctrl + L` (MacOS)
-   **Move Cursor Page Up**: `Alt + U` (Windows/Linux), `Ctrl + U` (MacOS)
-   **Move Cursor Page Down**: `Alt + O` (Windows/Linux), `Ctrl + O` (MacOS)
-   **Move Cursor Left End**: `Alt + H` (Windows/Linux), `Ctrl + H` (MacOS)
-   **Move Cursor Right End**: `Alt + ;` (Windows/Linux), `Ctrl + ;` (MacOS)

### Recommended Cursor Selection Shortcuts

-   **Select Cursor Up**: `Alt + Shift + I` (Windows/Linux), `Ctrl + Shift + I` (MacOS)
-   **Select Cursor Down**: `Alt + Shift + K` (Windows/Linux), `Ctrl + Shift + K` (MacOS)
-   **Select Cursor Left**: `Alt + Shift + J` (Windows/Linux), `Ctrl + Shift + J` (MacOS)
-   **Select Cursor Right**: `Alt + Shift + L` (Windows/Linux), `Ctrl + Shift + L` (MacOS)
-   **Select Cursor Left End**: `Alt + Shift + H` (Windows/Linux), `Ctrl + Shift + H` (MacOS)
-   **Select Cursor Right End**: `Alt + Shift + ;` (Windows/Linux), `Ctrl + Shift + ;` (MacOS)

### Setting Up Your Shortcuts

1. Open Obsidian Settings
2. Go to "Hotkeys"
3. Search for "Quick Nav"
4. Assign your preferred shortcuts to each operation

## Installation

### Method 1: Install via Obsidian Settings

1. Open Obsidian and go to `Settings`.
2. Navigate to the `Community plugins` tab.
3. Click on `Browse` and search for `Quick Nav`.
4. Click `Install` and then `Enable`.

### Method 2: Manual Installation

1. Download the latest release from the [GitHub repository](https://github.com/exoticknight/quick-nav/releases).
2. Extract the contents of the zip file.
3. Copy the extracted folder to your Obsidian vault's plugins directory: `/path/to/your/vault/.obsidian/plugins/`.
4. Open Obsidian and go to `Settings`.
5. Navigate to the `Community plugins` tab and enable `Quick Nav`.