Skip to content

Commit f1998f8

Browse files
committed
Document netrw-gx keybinding feature
1 parent cdc93cf commit f1998f8

File tree

2 files changed

+25
-6
lines changed

2 files changed

+25
-6
lines changed

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,17 @@
1212
- Seamless `nvim` + `nnn` integration. Use commands `nvim`, `:edit`, `:split`,
1313
`:vsplit`, etc.
1414

15+
- Keeps `netrw`'s "netrw-gx" feature. Open up file/URL under cursor with `gx`
16+
keybinding.
17+
1518
- Supports `nnn`'s "cd on quit" feature. See
1619
[nnn/wiki/Basic-use-cases#configure-cd-on-quit](https://github.com/jarun/nnn/wiki/Basic-use-cases#configure-cd-on-quit)
1720

1821
## 🌟 Project Goals
1922

2023
1. **Seamless integration** - E.g. use it with default commands.
2124
2. **User-friendly** - E.g. move between splits with default keybindings.
22-
3. **Minimal but feature complete** - E.g. implement "cd on quit", etc.
25+
3. **Minimal but feature complete** - E.g. implement "cd on quit", "gx", etc.
2326
4. **Clean code/Stable use** - E.g. don't use `nvim` in a way it is not meant
2427
to be used.
2528
5. **Low effort** - It should "just work" with low mental overhead.

doc/nnn-dir.txt

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,38 @@
11
*nnn-dir.txt* Seamless nvim + nnn integration
22
==============================================================================
3-
Author: Göran Gustafsson (gustafsson.g at gmail.com)
3+
Author: Göran Gustafsson <gustafsson.g@gmail.com>
44
License: BSD 3-Clause
55
Version: 0.1.0
66
Source: https://github.com/ggustafsson/nnn-dir.nvim
77

88
==============================================================================
9-
1. Introduction *nnn-dir*
9+
1. Introduction *nnn-dir*
1010

11-
`nnn-dir` replaces builtin |netrw| with external file manager `nnn`. Use
12-
commands |nvim|, |:edit|, |:split|, |:vsplit|, etc.
11+
- `nvim` plugin that replaces builtin |netrw| with external file manager
12+
`nnn`.
13+
14+
- `nnn` is a real file manager that can be used outside of `nvim`. Learn once,
15+
use everywhere!
16+
17+
- Seamless `nvim` + `nnn` integration. Use commands |nvim|, |:edit|, |:split|,
18+
|:vsplit|, etc.
19+
20+
- Keeps |netrw|'s |netrw-gx| feature. Open up file/URL under cursor with `gx`
21+
keybinding.
22+
23+
- Supports `nnn`'s "cd on quit" feature. See:
24+
https://github.com/jarun/nnn/wiki/Basic-use-cases#configure-cd-on-quit
1325

1426
==============================================================================
15-
2. Configuration *nnn-dir-configuration*
27+
2. Configuration *nnn-dir-configuration*
1628

1729
Enable `nnn-dir` with the following inside of `~/.config/nvim/init.[lua|vim]`:
1830
>
1931
[lua] require("nnn-dir").setup()
2032
<
33+
Override `gx` keybinding with custom command:
34+
>
35+
nnoremap gx :silent !custom-command "<cfile>"<CR>
36+
<
2137
==============================================================================
2238
vim:tw=78:ts=8:noet:ft=help:norl:

0 commit comments

Comments
 (0)