Merge pull request #128 from pranavrao145/docs/navigation

docs(navigation): added documentation for nav_next and nav_prev functions
This commit is contained in:
ThePrimeagen 2021-12-01 16:13:59 -07:00 committed by GitHub
commit f43d782abc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -58,10 +58,14 @@ This will mark the file and add it to the end of the mark list.
#### Navigate to file
To navigate to any of the marked files simply call the navigation function with
which index.
which index. There are also functions you can call to navigate to the next or
previous marks in the marks list.
```lua
:lua require("harpoon.ui").nav_file(3) -- This will navigate to file 3
:lua require("harpoon.ui").nav_next() -- This will navigate to the next mark
:lua require("harpoon.ui").nav_prev() -- This will navigate to the previous mark
```
#### Manipulating current marks