Skip to content

Commit

Permalink
chore(docs): auto-generate vimdoc
Browse files Browse the repository at this point in the history
  • Loading branch information
declancm committed Jul 21, 2024
1 parent 9874a4a commit b0cfdd0
Showing 1 changed file with 20 additions and 13 deletions.
33 changes: 20 additions & 13 deletions doc/cinnamon.nvim.txt
Original file line number Diff line number Diff line change
Expand Up @@ -58,38 +58,45 @@ DEFAULT OPTIONS ~
return {
-- Disable the plugin
disabled = false,

keymaps = {
-- Enable the provided 'basic' keymaps
basic = false,
-- Enable the provided 'extra' keymaps
extra = false,
},

---@class ScrollOptions
options = {
-- Optional post-movement callback
callback = function() end,
-- The scrolling mode
-- `cursor`: animate cursor and window scrolling for any movement
-- `window`: animate window scrolling ONLY when the cursor moves out of view
mode = "cursor",

-- Delay between each movement step (in ms)
delay = 5,
step_size = {
-- Number of cursor/window lines moved per step
vertical = 1,
-- Number of cursor/window columns moved per step
horizontal = 2,
},

max_delta = {
-- Maximum distance for line movements before scroll
-- animation is skipped. Set to `false` to disable
line = false,
-- Maximum distance for column movements before scroll
-- animation is skipped. Set to `false` to disable
column = false,
-- Maximum duration for a movement (in ms). Automatically scales the delay and step size
-- Maximum duration for a movement (in ms). Automatically scales the
-- delay and step size
time = 1000,
},
-- The scrolling mode
-- `cursor`: animate cursor and window scrolling for any movement
-- `window`: animate window scrolling ONLY when the cursor moves out of view
mode = "cursor",

step_size = {
-- Number of cursor/window lines moved per step
vertical = 1,
-- Number of cursor/window columns moved per step
horizontal = 2,
},

-- Optional post-movement callback. Not called if the movement is interrupted
callback = function() end,
},
}
<
Expand Down

0 comments on commit b0cfdd0

Please sign in to comment.