Skip to content

Commit

Permalink
chore(docs): auto-generate :help doc
Browse files Browse the repository at this point in the history
  • Loading branch information
@numToStr @github-actions
numToStr authored and github-actions[bot] committed Feb 2, 2023
1 parent eb8bc0c commit 91d8650
Showing 1 changed file with 68 additions and 69 deletions.
137 changes: 68 additions & 69 deletions doc/Navigator.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,27 +5,27 @@
| \| (_| \/ | (_| (_| |_ (_) | o | | \/ | | | |
_|

· Smoothly navigate between neovim and multipexers ·
· Smoothly navigate between neovim and multiplexer(s) ·


================================================================================
==============================================================================
Table of Contents *navigator.contents*

Introduction····················································|navigator-nvim|
Commands····················································|navigator.commands|
API and Config···················································|navigator.api|
Neovim navigator··················································|navigator.vi|
Tmux navigator··················································|navigator.tmux|
WezTerm navigator············································|navigator.wezterm|
Introduction ·················································· |navigator-nvim|
Commands ·················································· |navigator.commands|
API and Config ················································· |navigator.api|
Neovim navigator ················································ |navigator.vi|
Tmux navigator ················································ |navigator.tmux|
WezTerm navigator ·········································· |navigator.wezterm|

================================================================================
==============================================================================
Introduction *navigator-nvim*

Navigator.nvim provides set of functions and commands that allows you to seemlessly
Navigator.nvim provides set of functions and commands that allows you to seamlessly
navigate between neovim and different terminal multiplexers. It also allows you to
integrate your own custom multipexer.
integrate your own custom multiplexer.

================================================================================
==============================================================================
Commands *navigator.commands*

This plugin provides the following commands:
Expand All @@ -36,7 +36,7 @@ This plugin provides the following commands:
*NavigatorDown* - Go to down split/pane
*NavigatorPrevious* - Go to previous split/pane

================================================================================
==============================================================================
API and Config *navigator.api*

Config *navigator.api.Config*
Expand Down Expand Up @@ -67,79 +67,79 @@ Nav.setup({opts}) *navigator.api.setup*
{opts} (Config)

Usage: ~
>
-- With default config
require('Navigator').setup()
>lua
-- With default config
require('Navigator').setup()

-- With custom config
require('Navigator').setup({
auto_save = 'current'
disable_on_zoom = true
})
<
-- With custom config
require('Navigator').setup({
auto_save = 'current'
disable_on_zoom = true
})
<


Nav.left() *navigator.api.left*
Go to left split/pane

Usage: ~
>
require('Navigator').left()
>lua
require('Navigator').left()

-- With keybinding
vim.keymap.set({'n', 't'}, '<A-h>', require('Navigator').left)
<
-- With keybinding
vim.keymap.set({'n', 't'}, '<A-h>', require('Navigator').left)
<


Nav.up() *navigator.api.up*
Go to upper split/pane

Usage: ~
>
require('Navigator').up()
>lua
require('Navigator').up()

-- With keybinding
vim.keymap.set({'n', 't'}, '<A-k>', require('Navigator').up)
<
-- With keybinding
vim.keymap.set({'n', 't'}, '<A-k>', require('Navigator').up)
<


Nav.right() *navigator.api.right*
Go to right split/pane

Usage: ~
>
require('Navigator').right()
>lua
require('Navigator').right()

-- With keybinding
vim.keymap.set({'n', 't'}, '<A-l>', require('Navigator').right)
<
-- With keybinding
vim.keymap.set({'n', 't'}, '<A-l>', require('Navigator').right)
<


Nav.down() *navigator.api.down*
Go to down split/pane

Usage: ~
>
require('Navigator').down()
>lua
require('Navigator').down()

-- With keybinding
vim.keymap.set({'n', 't'}, '<A-j>', require('Navigator').down)
<
-- With keybinding
vim.keymap.set({'n', 't'}, '<A-j>', require('Navigator').down)
<


Nav.previous() *navigator.api.previous*
Go to previous split/pane

Usage: ~
>
require('Navigator').previous()
>lua
require('Navigator').previous()

-- With keybinding
vim.keymap.set({'n', 't'}, '<A-p>', require('Navigator').previous)
<
-- With keybinding
vim.keymap.set({'n', 't'}, '<A-p>', require('Navigator').previous)
<


================================================================================
==============================================================================
Neovim navigator *navigator.vi*

This module provides navigation and interaction for Neovim. This also acts
Expand All @@ -156,10 +156,9 @@ Vi:new() *navigator.vi:new*

Vi.zoomed() *navigator.vi.zoomed*
Checks whether neovim is maximized
NOTE: For neovim, this always returns `false`.

Returns: ~
(boolean)
(boolean) For neovim, it'll always returns `false`


Vi:navigate({direction}) *navigator.vi:navigate*
Expand All @@ -172,7 +171,7 @@ Vi:navigate({direction}) *navigator.vi:navigate*
(Vi)


================================================================================
==============================================================================
Tmux navigator *navigator.tmux*

This module provides navigation and interaction for Tmux, and uses |navigator.vi|
Expand All @@ -187,15 +186,15 @@ Tmux:new() *navigator.tmux:new*
(Tmux)

Usage: ~
>
local ok, tmux = pcall(function()
return require('Navigator.mux.tmux'):new()
end)
>lua
local ok, tmux = pcall(function()
return require('Navigator.mux.tmux'):new()
end)

require('Navigator').setup({
mux = ok and tmux or 'auto'
})
<
require('Navigator').setup({
mux = ok and tmux or 'auto'
})
<


Tmux:zoomed() *navigator.tmux:zoomed*
Expand All @@ -215,7 +214,7 @@ Tmux:navigate({direction}) *navigator.tmux:navigate*
(Tmux)


================================================================================
==============================================================================
WezTerm navigator *navigator.wezterm*

This module provides navigation and interaction for WezTerm, and uses |navigator.vi|
Expand All @@ -231,15 +230,15 @@ WezTerm:new() *navigator.wezterm:new*
(WezTerm)

Usage: ~
>
local ok, wezterm = pcall(function()
return require('Navigator.mux.wezterm'):new()
end)
require('Navigator').setup({
mux = ok and wezterm or 'auto'
})
<
>lua
local ok, wezterm = pcall(function()
return require('Navigator.mux.wezterm'):new()
end)

require('Navigator').setup({
mux = ok and wezterm or 'auto'
})
<


WezTerm:navigate({direction}) *navigator.wezterm:navigate*
Expand Down

0 comments on commit 91d8650

Please sign in to comment.