Simple markdown previewer for neovim
Warning
This plugin is in it's alpha stage and may go through breaking changes.
- Fully customisable markdown
headings. - Custom
block quoteswith support forcallouts&alerts. - Custom
code blockswith different style supports. - Statusline-like
horizontal rulescustomisation. - Custom
linksandimage links. - Custom
inline codes. - Padded list items(with nested list support).
- Custom
checkboxesfor different checkbox states. - Fully customisable
tables.
- Neovim version: 0.10 or higher(unless API changes occurred).
nvim-treesitterfor easy installation of treesitter parsers.markdownandmarkdown_inlinetreesitter parsers.nvim-web-deviconsfor the icons.
For plugins.lua or lazy.lua users.
{
"OXY2DEV/markview.nvim",
dependencies = {
-- You may not need this if you don't lazy load
-- Or if the parsers are in your $RUNTIMEPATH
"nvim-treesitter/nvim-treesitter",
"nvim-tree/nvim-web-devicons"
},
}For plugins/markview.lua users
return {
"OXY2DEV/markview.nvim",
dependencies = {
-- You may not need this if you don't lazy load
-- Or if the parsers are in your $RUNTIMEPATH
"nvim-treesitter/nvim-treesitter",
"nvim-tree/nvim-web-devicons"
},
}local MiniDeps = require("mini.deps");
MiniDeps.add({
source = "OXY2DEV/markview.nvim",
depends = {
-- You may not need this if you don't lazy load
-- Or if the parsers are in your $RUNTIMEPATH
"nvim-treesitter/nvim-treesitter",
"nvim-tree/nvim-web-devicons"
}
})The installation process for any other plugin manager(s) is the same.
If your plugin manager doesn't support dependencies then you can always load the plugins in the right order.
Plug "nvim-treesitter/nvim-treesitter"
Plug "nvim-tree/nvim-web-devicons"
Plug "OXY2DEV/markview.nvim"Note
This plugin does not use setup() to initialize. So, it is completely optional to call it.
Configuration table for the setup() function is given below.
require("markview").setup({
buf_ignore = { "nofile" },
modes = { "n" },
-- Returns the conceallevel to the global value when changing modes
restore_conceallevel = true,
-- Returns the concealcursor to the global value when changing modes
restore_concealcursor = false,
headings = {},
code_blocks = {},
block_quotes = {},
horizontal_rules = {},
hyperlinks = {},
images = {},
inline_codes = {},
list_items = {},
list_items = {},
checkboxes = {},
tables = {}
});For customisation related options check the wiki pages.
Important
Screenshots on a phone are very blurry(Yes, the plugin was made on my phone).
If you have screenshots of the plugin, you can submit them in the special issue(not yet open). And yes, credit will be provided.