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

Update Doc

Browse Source
This commit is contained in:
Syed Daanish
2025-02-08 23:11:35 +03:00
parent b38c1f6f8e
commit a9757dcb82
1 changed files with 82 additions and 67 deletions
Download Patch File Download Diff File Expand all files Collapse all files

121
doc/picvim.txt
View File

@@ -1,91 +1,106 @@
*picvim.txt* Plugin documentation for picvim *picvim* Plugin documentation for picvim
============================================================================== ==============================================================================
NAME INDEX
|picvim|
|NAME|
|SYNOPSIS|
|INSTALLATION|
|CONFIGURATION|
|USAGE|
|HELP|
==============================================================================
*NAME*
picvim - A Neovim plugin for viewing and manipulating images. picvim - A Neovim plugin for viewing and manipulating images.
============================================================================== ==============================================================================
SYNOPSIS *SYNOPSIS*
lua require'picvim'.setup({ options })
Configurable key mappings for image navigation and manipulation. 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
and manipulation.
> lua require'picvim'.setup({ keymap = { ... } })
<
============================================================================== ==============================================================================
INSTALLATION *INSTALLATION*
Use your preferred plugin manager, e.g., with lazy.nvim: Use your preferred plugin manager, e.g., with lazy.nvim:
```lua > {
{ > 'Toprun123/PicVim',
'yourusername/picvim', > config = function()
config = function() > require'picvim'.setup({
require'picvim'.setup({ > keymap = { -- Default keymaps
keymap = { > move_left = { "<Left>", "h" }, -- Pan left
move_left = { "<Left>", "h" }, > move_right = { "<Right>", "l" }, -- Pan right
move_right = { "<Right>", "l" }, > move_down = { "<Down>", "j" }, -- Pan down
move_down = { "<Down>", "j" }, > move_up = { "<Up>", "k" }, -- Pan up
move_up = { "<Up>", "k" }, > zoom_in = { "=", "+" }, -- Zoom in
zoom_in = { "=", "+" }, > zoom_out = { "-", "_" }, -- Zoom out
zoom_out = { "-", "_" }, > rotate_clockwise = "t", -- Rotate clockwise by 30 degrees
rotate_clockwise = "t", > rotate_counterclockwise = "T", -- Rotate counterclockwise by 30 degrees
rotate_counterclockwise = "T", > reset = "o", -- Reset image
reset = "o", > rerender = "r", -- Rerender image
rerender = "r", > }
} > })
}) > end
end > }
} <
```
============================================================================== ==============================================================================
CONFIGURATION *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 |
|----------------------------|-------------------------|------------------------------------| |-------------------------------------------------------------------------|
| `move_left` | `{"<Left>", "h"}` | Moves the image left | | `move_left` | `{"<Left>", "h"}` | Moves the image left |
| `move_right` | `{"<Right>", "l"}` | Moves the image right | | `move_right` | `{"<Right>", "l"}` | Moves the image right |
| `move_down` | `{"<Down>", "j"}` | Moves the image down | | `move_down` | `{"<Down>", "j"}` | Moves the image down |
| `move_up` | `{"<Up>", "k"}` | Moves the image up | | `move_up` | `{"<Up>", "k"}` | Moves the image up |
| `zoom_in` | `{"=", "+"}` | Zooms into the image | | `zoom_in` | `{"=", "+"}` | Zooms into the image |
| `zoom_out` | `{"-", "_"}` | Zooms out of the image | | `zoom_out` | `{"-", "_"}` | Zooms out of the image |
| `rotate_clockwise` | `"t"` | Rotates the image clockwise | | `rotate_clockwise` | `"t"` | Rotates clockwise |
| `rotate_counterclockwise` | `"T"` | Rotates the image counterclockwise | | `rotate_counterclockwise` | `"T"` | Rotates counterclockwise |
| `reset` | `"o"` | Resets the image | | `reset` | `"o"` | Resets the image |
| `rerender` | `"r"` | Rerenders the image | | `rerender` | `"r"` | Rerenders the image |
|-------------------------------------------------------------------------|
============================================================================== ==============================================================================
USAGE *USAGE*
1. Open an image file in Neovim. 1. Open an image file in Neovim.
2. Use the configured keymaps to move, zoom, or rotate the image. 2. Use the configured (or default) keymaps to move, zoom, or rotate the image.
3. Press `o` to reset the image to its original state. 3. Press `o` to reset the image to its original state.
4. Press `r` to force a re-render. 4. Press `r` to force a re-render.
============================================================================== ==============================================================================
HELP *HELP*
To view this help file inside Neovim, use: To view this help file inside Neovim, use:
:help picvim > :h picvim
<
============================================================================== ==============================================================================
vim:tw=78:ts=4:ft=help:norl:ft=help
*EOF*