Skip to content

Commit 5c9e0b5

Browse files
numToStrgithub-actions[bot]
numToStr
authored and
github-actions[bot]
committed
chore(docs): auto-generate :help doc
1 parent e2bfe88 commit 5c9e0b5

File tree

1 file changed

+255
-0
lines changed

1 file changed

+255
-0
lines changed

‎doc/Navigator.txt‎

Lines changed: 255 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,255 @@
1+
*navigator-nvim.txt* For Neovim version 0.7 Last change: 2020 Dec 16
2+
3+
4+
|\ | _. o _ _. _|_ _ ._ ._ o ._ _
5+
| \| (_| \/ | (_| (_| |_ (_) | o | | \/ | | | |
6+
_|
7+
8+
· Smoothly navigate between neovim and multipexers ·
9+
10+
11+
================================================================================
12+
Table of Contents *navigator.contents*
13+
14+
Introduction····················································|navigator-nvim|
15+
Commands····················································|navigator.commands|
16+
API and Config···················································|navigator.api|
17+
Neovim navigator··················································|navigator.vi|
18+
Tmux navigator··················································|navigator.tmux|
19+
WezTerm navigator············································|navigator.wezterm|
20+
21+
================================================================================
22+
Introduction *navigator-nvim*
23+
24+
Navigator.nvim provides set of functions and commands that allows you to seemlessly
25+
navigate between neovim and different terminal multiplexers. It also allows you to
26+
integrate your own custom multipexer.
27+
28+
================================================================================
29+
Commands *navigator.commands*
30+
31+
This plugin provides the following commands:
32+
33+
*NavigatorLeft* - Go to left split/pane
34+
*NavigatorRight* - Go to right split/pane
35+
*NavigatorUp* - Go to upper split/pane
36+
*NavigatorDown* - Go to down split/pane
37+
*NavigatorPrevious* - Go to previous split/pane
38+
39+
================================================================================
40+
API and Config *navigator.api*
41+
42+
Config *navigator.api.Config*
43+
44+
Fields: ~
45+
{auto_save?} ("current"|"all") Save modified buffer(s) when moving
46+
to mux from neovim (default: `nil`)
47+
{disable_on_zoom} (boolean) Disable navigation when the current
48+
mux pane is zoomed in (default: `false`)
49+
{mux} ("auto"|Vi) Multiplexer to use (default: "auto")
50+
51+
52+
Direction *navigator.api.Direction*
53+
Enum of navigation direction analogous of neovim window movement
54+
55+
Variants: ~
56+
("p") Previous Pane
57+
("h") Left Pane
58+
("j") Lower Pane
59+
("k") Upper Pane
60+
("l") Right Pane
61+
62+
63+
Nav.setup({opts}) *navigator.api.setup*
64+
Configure the plugin
65+
66+
Parameters: ~
67+
{opts} (Config)
68+
69+
Usage: ~
70+
>
71+
-- With default config
72+
require('Navigator').setup()
73+
74+
-- With custom config
75+
require('Navigator').setup({
76+
auto_save = 'current'
77+
disable_on_zoom = true
78+
})
79+
<
80+
81+
82+
Nav.left() *navigator.api.left*
83+
Go to left split/pane
84+
85+
Usage: ~
86+
>
87+
require('Navigator').left()
88+
89+
-- With keybinding
90+
vim.keymap.set({'n', 't'}, '<A-h>', require('Navigator').left)
91+
<
92+
93+
94+
Nav.up() *navigator.api.up*
95+
Go to upper split/pane
96+
97+
Usage: ~
98+
>
99+
require('Navigator').up()
100+
101+
-- With keybinding
102+
vim.keymap.set({'n', 't'}, '<A-k>', require('Navigator').up)
103+
<
104+
105+
106+
Nav.right() *navigator.api.right*
107+
Go to right split/pane
108+
109+
Usage: ~
110+
>
111+
require('Navigator').right()
112+
113+
-- With keybinding
114+
vim.keymap.set({'n', 't'}, '<A-l>', require('Navigator').right)
115+
<
116+
117+
118+
Nav.down() *navigator.api.down*
119+
Go to down split/pane
120+
121+
Usage: ~
122+
>
123+
require('Navigator').down()
124+
125+
-- With keybinding
126+
vim.keymap.set({'n', 't'}, '<A-j>', require('Navigator').down)
127+
<
128+
129+
130+
Nav.previous() *navigator.api.previous*
131+
Go to previous split/pane
132+
133+
Usage: ~
134+
>
135+
require('Navigator').previous()
136+
137+
-- With keybinding
138+
vim.keymap.set({'n', 't'}, '<A-p>', require('Navigator').previous)
139+
<
140+
141+
142+
================================================================================
143+
Neovim navigator *navigator.vi*
144+
145+
This module provides navigation and interaction for Neovim. This also acts
146+
as a base class for other multiplexer implementation.
147+
148+
Read: https://github.com/numToStr/Navigator.nvim/wiki/Custom-Multiplexer
149+
150+
Vi:new() *navigator.vi:new*
151+
Creates new Neovim navigator instance
152+
153+
Returns: ~
154+
(Vi)
155+
156+
157+
Vi.zoomed() *navigator.vi.zoomed*
158+
Checks whether neovim is maximized
159+
NOTE: For neovim, this always returns `false`.
160+
161+
Returns: ~
162+
(boolean)
163+
164+
165+
Vi:navigate({direction}) *navigator.vi:navigate*
166+
Navigate inside neovim
167+
168+
Parameters: ~
169+
{direction} (Direction) See |navigator.api.Direction|
170+
171+
Returns: ~
172+
(Vi)
173+
174+
175+
================================================================================
176+
Tmux navigator *navigator.tmux*
177+
178+
This module provides navigation and interaction for Tmux, and uses |navigator.vi|
179+
as a base class. This is used automatically when tmux is detected on host
180+
system but can also be used to manually override the mux.
181+
Read also: https://github.com/numToStr/Navigator.nvim/wiki/Tmux-Integration
182+
183+
Tmux:new() *navigator.tmux:new*
184+
Creates a new Tmux navigator instance
185+
186+
Returns: ~
187+
(Tmux)
188+
189+
Usage: ~
190+
>
191+
local ok, tmux = pcall(function()
192+
return require('Navigator.mux.tmux'):new()
193+
end)
194+
195+
require('Navigator').setup({
196+
mux = ok and tmux or 'auto'
197+
})
198+
<
199+
200+
201+
Tmux:zoomed() *navigator.tmux:zoomed*
202+
Checks if tmux is zoomed in
203+
204+
Returns: ~
205+
(boolean)
206+
207+
208+
Tmux:navigate({direction}) *navigator.tmux:navigate*
209+
Switch pane in tmux
210+
211+
Parameters: ~
212+
{direction} (Direction) See |navigator.api.Direction|
213+
214+
Returns: ~
215+
(Tmux)
216+
217+
218+
================================================================================
219+
WezTerm navigator *navigator.wezterm*
220+
221+
This module provides navigation and interaction for WezTerm, and uses |navigator.vi|
222+
as a base class. This is used automatically when wezterm is detected on host system
223+
but can also be used to manually override the mux.
224+
225+
Read also: https://github.com/numToStr/Navigator.nvim/wiki/WezTerm-Integration
226+
227+
WezTerm:new() *navigator.wezterm:new*
228+
Creates a new WezTerm navigator instance
229+
230+
Returns: ~
231+
(WezTerm)
232+
233+
Usage: ~
234+
>
235+
local ok, wezterm = pcall(function()
236+
return require('Navigator.mux.wezterm'):new()
237+
end)
238+
239+
require('Navigator').setup({
240+
mux = ok and wezterm or 'auto'
241+
})
242+
<
243+
244+
245+
WezTerm:navigate({direction}) *navigator.wezterm:navigate*
246+
Switch pane in wezterm
247+
248+
Parameters: ~
249+
{direction} (Direction) See |navigator.api.Direction|
250+
251+
Returns: ~
252+
(WezTerm)
253+
254+
255+
vim:tw=78:ts=8:noet:ft=help:norl:

0 commit comments

Comments
 (0)