SyedM/PicVim
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix VimDoc

Browse Source
This commit is contained in:
Syed Daanish
2025-02-08 23:23:45 +03:00
parent a9757dcb82
commit acc8cee116
1 changed files with 38 additions and 54 deletions
Download Patch File Download Diff File Expand all files Collapse all files

92
doc/picvim.txt
View File

@@ -1,9 +1,9 @@
*picvim* Plugin documentation for picvim *PicVim* A Neovim plugin for viewing and manipulating images
============================================================================== ==============================================================================
INDEX INDEX
|picvim| |PicVim|
|NAME|
|SYNOPSIS| |SYNOPSIS|
|INSTALLATION| |INSTALLATION|
|CONFIGURATION| |CONFIGURATION|
@@ -11,66 +11,49 @@ INDEX
|HELP| |HELP|
============================================================================== ==============================================================================
*NAME*
picvim - A Neovim plugin for viewing and manipulating images.
============================================================================== 1. *SYNOPSIS*
*SYNOPSIS*
PicVim is a Neovim plugin that allows you to view and manipulate images in a PicVim is a Neovim plugin that allows you to view and manipulate images in a
Neovim buffer. It also provides configurable key mappings for image navigation Neovim buffer. It also provides configurable key mappings for image navigation
and manipulation. and manipulation.
>lua
> lua require'picvim'.setup({ keymap = { ... } }) require'picvim'.setup({ keymap = { ... } })
< <
============================================================================== ==============================================================================
*INSTALLATION*
2. *INSTALLATION*
Use your preferred plugin manager, e.g., with lazy.nvim: Use your preferred plugin manager, e.g., with lazy.nvim:
>lua
> { {
> 'Toprun123/PicVim', 'Toprun123/PicVim',
> config = function() config = function()
> require'picvim'.setup({ require'picvim'.setup()
> keymap = { -- Default keymaps end
> move_left = { "<Left>", "h" }, -- Pan left }
> move_right = { "<Right>", "l" }, -- Pan right
> move_down = { "<Down>", "j" }, -- Pan down
> move_up = { "<Up>", "k" }, -- Pan up
> zoom_in = { "=", "+" }, -- Zoom in
> zoom_out = { "-", "_" }, -- Zoom out
> rotate_clockwise = "t", -- Rotate clockwise by 30 degrees
> rotate_counterclockwise = "T", -- Rotate counterclockwise by 30 degrees
> reset = "o", -- Reset image
> rerender = "r", -- Rerender image
> }
> })
> end
> }
< <
============================================================================== ==============================================================================
*CONFIGURATION*
3. *CONFIGURATION*
The plugin can be configured using: The plugin can be configured using:
>lua
> require'picvim'.setup({ require'picvim'.setup({
> keymap = { keymap = {
> move_left = { "<Left>", "h" }, -- Pan left move_left = { "<Left>", "h" }, -- Pan left
> move_right = { "<Right>", "l" }, -- Pan right move_right = { "<Right>", "l" }, -- Pan right
> move_down = { "<Down>", "j" }, -- Pan down move_down = { "<Down>", "j" }, -- Pan down
> move_up = { "<Up>", "k" }, -- Pan up move_up = { "<Up>", "k" }, -- Pan up
> zoom_in = { "=", "+" }, -- Zoom in zoom_in = { "=", "+" }, -- Zoom in
> zoom_out = { "-", "_" }, -- Zoom out zoom_out = { "-", "_" }, -- Zoom out
> rotate_clockwise = "t", -- Rotate clockwise rotate_clockwise = "t", -- Rotate clockwise
> rotate_counterclockwise = "T", -- Rotate counterclockwise rotate_counterclockwise = "T", -- Rotate counterclockwise
> reset = "o", -- Reset image reset = "o", -- Reset image
> rerender = "r", -- Rerender image rerender = "r", -- Rerender image
> } }
> }) })
< <
|-------------------------------------------------------------------------| |-------------------------------------------------------------------------|
| Options within `keymap` | Default Value | Description | | Options within `keymap` | Default Value | Description |
|-------------------------------------------------------------------------| |-------------------------------------------------------------------------|
@@ -87,7 +70,8 @@ The plugin can be configured using:
|-------------------------------------------------------------------------| |-------------------------------------------------------------------------|
============================================================================== ==============================================================================
*USAGE*
4. *USAGE*
1. Open an image file in Neovim. 1. Open an image file in Neovim.
2. Use the configured (or default) keymaps to move, zoom, or rotate the image. 2. Use the configured (or default) keymaps to move, zoom, or rotate the image.
@@ -95,12 +79,12 @@ The plugin can be configured using:
4. Press `r` to force a re-render. 4. Press `r` to force a re-render.
============================================================================== ==============================================================================
*HELP*
5. *HELP*
To view this help file inside Neovim, use: To view this help file inside Neovim, use:
>
> :h picvim :h picvim
< <
============================================================================== ==============================================================================
vim:tw=78:ts=4:ft=help:norl:ft=help vim:tw=78:ts=4:ft=help:norl:ft=help