| CARVIEW |
Navigation Menu
-
Notifications
You must be signed in to change notification settings - Fork 63
Preview
Tip
Type definitions are available in definitions/preview.lua.
Options that change when & how previews are shown are part of this. Default value can be found here.
---@type markview.config.preview
preview = {
enable = true,
enable_hybrid_mode = true,
callbacks = {
on_attach = function (_, wins)
---@type boolean
local attach_state = spec.get({ "preview", "enable" }, { fallback = true, ignore_enable = true });
if attach_state == false then
return;
end
for _, win in ipairs(wins) do
vim.wo[win].conceallevel = 3;
end
end,
on_detach = function (_, wins)
for _, win in ipairs(wins) do
vim.wo[win].conceallevel = 0;
end
end,
on_enable = function (_, wins)
local attach_state = spec.get({ "preview", "enable" }, { fallback = true, ignore_enable = true });
if attach_state == false then
---@type string[]
local preview_modes = spec.get({ "preview", "modes" }, { fallback = {}, ignore_enable = true });
---@type string[]
local hybrid_modes = spec.get({ "preview", "hybrid_modes" }, { fallback = {}, ignore_enable = true });
local concealcursor = "";
for _, mode in ipairs(preview_modes) do
if vim.list_contains(hybrid_modes, mode) == false and vim.list_contains({ "n", "v", "i", "c" }, mode) then
concealcursor = concealcursor .. mode;
end
end
for _, win in ipairs(wins) do
vim.wo[win].conceallevel = 3;
vim.wo[win].concealcursor = concealcursor;
end
else
for _, win in ipairs(wins) do
vim.wo[win].conceallevel = 3;
end
end
end,
on_disable = function (_, wins)
for _, win in ipairs(wins) do
vim.wo[win].conceallevel = 0;
end
end,
on_hybrid_enable = function (_, wins)
---@type string[]
local preview_modes = spec.get({ "preview", "modes" }, { fallback = {}, ignore_enable = true });
---@type string[]
local hybrid_modes = spec.get({ "preview", "hybrid_modes" }, { fallback = {}, ignore_enable = true });
local concealcursor = "";
for _, mode in ipairs(preview_modes) do
if vim.list_contains(hybrid_modes, mode) == false and vim.list_contains({ "n", "v", "i", "c" }, mode) then
concealcursor = concealcursor .. mode;
end
end
for _, win in ipairs(wins) do
vim.wo[win].concealcursor = concealcursor;
end
end,
on_hybrid_disable = function (_, wins)
---@type string[]
local preview_modes = spec.get({ "preview", "modes" }, { fallback = {}, ignore_enable = true });
local concealcursor = "";
for _, mode in ipairs(preview_modes) do
if vim.list_contains({ "n", "v", "i", "c" }, mode) then
concealcursor = concealcursor .. mode;
end
end
for _, win in ipairs(wins) do
vim.wo[win].concealcursor = concealcursor;
end
end,
on_mode_change = function (_, wins, current_mode)
---@type string[]
local preview_modes = spec.get({ "preview", "modes" }, { fallback = {}, ignore_enable = true });
---@type string[]
local hybrid_modes = spec.get({ "preview", "hybrid_modes" }, { fallback = {}, ignore_enable = true });
local concealcursor = "";
for _, mode in ipairs(preview_modes) do
if vim.list_contains(hybrid_modes, mode) == false and vim.list_contains({ "n", "v", "i", "c" }, mode) then
concealcursor = concealcursor .. mode;
end
end
for _, win in ipairs(wins) do
if vim.list_contains(preview_modes, current_mode) then
vim.wo[win].conceallevel = 3;
vim.wo[win].concealcursor = concealcursor;
else
vim.wo[win].conceallevel = 0;
vim.wo[win].concealcursor = "";
end
end
end,
on_splitview_open = function (_, _, win)
vim.wo[win].conceallevel = 3;
vim.wo[win].concealcursor = "n";
end
},
map_gx = true,
debounce = 150,
icon_provider = "internal",
filetypes = { "markdown", "quarto", "rmd", "typst" },
ignore_buftypes = { "nofile" },
raw_previews = {},
modes = { "n", "no", "c" },
hybrid_modes = {},
linewise_hybrid_mode = false,
max_buf_lines = 1000,
draw_range = { 2 * vim.o.lines, 2 * vim.o.lines },
edit_range = { 0, 0 },
splitview_winopts = {
split = "right"
},
}- type:
booleandefault:true
Enables previews on any newly attached buffers.
Tip
You can set this to false, if you prefer using splitview or have keymap for toggling previews!
- type:
booleandefault:true
Enables hybrid mode in previews.
Note
This has no effect if hybrid_modes isn't set!
Also see,
Callbacks are functions that can be run when specific things/events happen. Supported callbacks are,
Show callbacks
- type:
function
Parameters,
-
buf, integer The buffer being attached to. -
wins, integer[] Windows that containbuf.
Called when attaching to a buffer.
- type:
function
Parameters,
-
buf, integer The buffer being attached to. -
wins, integer[] Windows that containbuf.
Called right before detaching from a buffer.
- type:
function
Parameters,
-
buf, integer The buffer preview is being shown on. -
wins, integer[] Windows that containbuf.
Called when enabling previews in a buffer.
- type:
function
Parameters,
-
buf, integer The buffer preview is being disabled on. -
wins, integer[] Windows that containbuf.
Called right before disabling previews in a buffer.
- type:
function
Parameters,
-
buf, integer The buffer where hybrid mode is being enabled on. -
wins, integer[] Windows that containbuf.
Called when enabling hybrid mode in a buffer.
- type:
function
Parameters,
-
buf, integer The buffer where hybrid mode is being disabled on. -
wins, integer[] Windows that containbuf.
Called when disabling hybrid mode in a buffer.
[!CAUTION] Deprecated. Use at your own risk!
- type:
function
Parameters,
-
buf, integer Buffer that emittedModeChanged. -
wins, integer[] Windows that containbuf. -
mode, string Vim mode shorthand.
Called when changing modes.
- type:
function
Parameters,
-
source, integer Buffer whose preview will be shown. -
splitview_buf, integer Preview buffer. -
splitview_win, integer Preview window.
Called after running splitOpen.
- type:
function
Parameters,
-
source, integer Buffer whose preview is being shown. -
splitview_buf, integer Preview buffer. -
splitview_win, integer Preview window.
Called after running splitClose.
Caution
As off 0.11.1, this is no longer needed(at least for markdown) and is only left true for people who use old versions of Neovim.
This will be removed in a future release!
- type:
booleandefault:true
Re-maps gx to support opening various links from markdown & typst.
- type:
integerdefault:150
Debounce delay for updating previews.
Caution
Smaller values may impact performance negatively!
- type:
"" | "internal" | "devicons" | "mini"default:"internal"
Icon provider to use in various parts of the plugin(e.g. code blocks).
- type:
string[]default:{ "markdown", "quarto", "rmd", "typst" }
Filetypes that should show previews. The plugin will attach to any buffers matching any of these filetypes.
You can add support for extra filetypes like so,
require("markview").setup({
preview = {
filetypes = { "some_custom_filetype", "markdown", "quarto", "rmd", "typst" },
},
});- type:
string[]default:{ "nofile" }
Buftypes that should be ignored by this plugin. Buffers whose filetype matches any of these will not be attached to(even if the filetype matches filetypes).
You can enable markview.nvim for nofile buffers like so,
Important
This might not always work for some buffers(e.g. LSP hover) as they may disable autocmds from firing or use hidden windows.
require("markview").setup({
preview = {
ignore_buftypes = {},
},
});Important
This option only has effects if hybrid_modes is active!
- type: markview.config.preview.raw
default:
{}
A map of language & preview options defining what should be shown as raw text in hybrid mode.
require("markview").setup({
preview = {
raw_previews = {
-- This will cause only table's to show
-- up as raw markdown in hybrid mode.
markdown = { "tables" },
-- An empty list means everything will show
-- up as raw.
markdown_inline = {},
html = {},
latex = {},
typst = {},
yaml = {},
}
}
});| Normal hybrid mode | Hybrid mode with raw_previews
|
|---|---|
 |
 |
- type:
string[]default:{ "n", "no", "c" }
List of Vim-mode short-hands where preview will be shown. Possible values are,
-
n, Normal mode -
i, Insert mode -
v, Visual mode -
V, Visual-line mode -
, Visual-block mode -
no, Normal-operation mode -
c, Command mode
You enable the plugin for visual mode like so,
require("markview").setup({
preview = {
modes = { "v", "n", "no", "c" },
},
});- type:
string[]default:{}
Important
The mode must also be present in preview.modes.
List of Vim-mode short-hands where hybrid mode will be used. Possible values are the same as modes.
To have rendering enabled while in insert mode you can use this,
require("markview").setup({
preview = {
modes = { "i", "n", "no", "c" },
hybrid_modes = { "i" },
},
});- type:
booleandefault:false
Makes hybrid mode show the raw version of the line under the cursor instead of all the lines creating the tree-sitter node under the cursor.
To only show the current line as raw markdown when using previews in insert mode you can use this,
require("markview").setup({
preview = {
modes = { "i", "n", "no", "c" },
hybrid_modes = { "i" },
linewise_hybrid_mode = true,
},
});Tip
You can modify edit_range to change how many lines are shown as raw!
- type:
integerdefault:1000
Maximum number of lines a buffer can have for it to be rendered entirely.
If the number of lines is larger than this value, only the lines in the draw_range surrounding the cursor will be rendered.
Caution
Setting this to a large value may impact performance negatively!
- type:
[ integer, integer ]default:{ 2 * vim.o.lines, 2 * vim.o.lines }
Number of lines before & after the cursor to render/draw.
Important
This is done for every cursor a buffer has! A large value will impact performance negatively!
Note
This option only affects hybrid mode!
- type:
[ integer, integer ]default:{ 0, 0 }
Number of lines before & after that will be considered being edited.
If linewise_hybrid_mode is enabled, this determines the number of lines that will shown raw around each cursor.
Otherwise, this will be used determine which nodes are considered under the cursor.
- type:
vim.api.keyset.win_configdefault:{ split = "right" }
Window configuration for the splitview window.