Skip to content

docs: update keys for search #22

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 27, 2024
Merged

docs: update keys for search #22

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fc7da39
docs: update keys for search
dlvhdr Sep 27, 2024
0e8a44a
docs: update image
dlvhdr Sep 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 15 additions & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
A git diff pager based on [delta](https://github.com/dandavison/delta) but with a file tree, à la GitHub.

<p align="center">
<img width="750" src="https://github.com/user-attachments/assets/359cd2a3-a22f-4572-8a09-aa57befadd5d" />
<img width="750" src="https://github.com/user-attachments/assets/0a5bc0c9-9b74-4bca-8b8d-423bcf859e68" />
</p>

> [!CAUTION]
Expand Down Expand Up @@ -55,24 +55,25 @@ git config --global pager.diff diffnav

## Keys

| Key | Description |
|:-------------------|:--------------------------------|
| <kbd>j</kbd> | Next file |
| <kbd>k</kbd> | Previous file |
| <kbd>Ctrl-d</kbd> | Scroll the diff down |
| <kbd>Ctrl-u</kbd> | Scroll the diff up |
| <kbd>e</kbd> | Toggle the file tree |
| <kbd>q</kbd> | Quit |
| Key | Description |
| :---------------- | :------------------- |
| <kbd>j</kbd> | Next file |
| <kbd>k</kbd> | Previous file |
| <kbd>Ctrl-d</kbd> | Scroll the diff down |
| <kbd>Ctrl-u</kbd> | Scroll the diff up |
| <kbd>e</kbd> | Toggle the file tree |
| <kbd>t</kbd> | Search/go-to file |
| <kbd>q</kbd> | Quit |

## Under the hood

`diffnav` uses:

* [Bubble Tea](https://github.com/charmbracelet/bubbletea) for the TUI
* [`delta`](https://github.com/dandavison/delta) for viewing the diffed file
- [Bubble Tea](https://github.com/charmbracelet/bubbletea) for the TUI
- [`delta`](https://github.com/dandavison/delta) for viewing the diffed file

Screenshots use:

* [kitty](https://sw.kovidgoyal.net/kitty/) for the terminal
* [tokyonight](https://github.com/folke/tokyonight.nvim) for the color scheme
* [CommitMono](https://www.nerdfonts.com/font-downloads) for the font
- [kitty](https://sw.kovidgoyal.net/kitty/) for the terminal
- [tokyonight](https://github.com/folke/tokyonight.nvim) for the color scheme
- [CommitMono](https://www.nerdfonts.com/font-downloads) for the font