Files
nvim-modular/lua/kickstart/plugins/markdown.lua
2025-08-24 20:10:59 +02:00

117 lines
3.8 KiB
Lua

-- Markdown
-- https://github.com/MeanderingProgrammer/render-markdown.nvim
return {
{
'MeanderingProgrammer/render-markdown.nvim',
-- dependencies = { 'nvim-treesitter/nvim-treesitter', 'echasnovski/mini.nvim' }, -- if you use the mini.nvim suite
-- dependencies = { 'nvim-treesitter/nvim-treesitter', 'echasnovski/mini.icons' }, -- if you use standalone mini plugins
dependencies = { 'nvim-treesitter/nvim-treesitter', 'nvim-tree/nvim-web-devicons' }, -- if you prefer nvim-web-devicons
---@module 'render-markdown'
---@type render.md.UserConfig
opts = {
-- run on both Markdown and Quarto files
file_types = { 'markdown', 'quarto', 'vimwiki' },
-- means that in normal, command, and terminal modes you'll get a rendered view,
-- and in other modes such as insert the marks added by the plugin will disappear.
-- render_modes = { 'n', 'c', 't' },
-- in all modes
render_modes = true,
completions = {
blink = { enabled = true },
lsp = { enabled = true },
},
-- checkbox = {
-- enabled = true,
-- render_modes = true,
-- bullet = true,
-- right_pad = 1,
-- unchecked = {
-- icon = '󰄱 ',
-- highlight = 'RenderMarkdownUnchecked',
-- scope_highlight = nil,
-- },
-- checked = {
-- icon = '󰱒 ',
-- highlight = 'RenderMarkdownChecked',
-- scope_highlight = nil,
-- },
-- custom = {
-- todo = {
-- raw = '[-]',
-- rendered = '󰥔 ',
-- highlight = 'RenderMarkdownTodo',
-- scope_highlight = nil,
-- },
-- important = {
-- raw = '[~]',
-- rendered = '󰓎 ',
-- highlight = 'DiagnosticWarn',
-- },
-- checked = {
-- scope_highlight = '@markup.strikethrough',
-- },
-- },
-- },
-- code = {
-- enabled = true,
-- render_modes = false,
-- sign = true,
-- conceal_delimiters = true,
-- language = true,
-- position = 'left',
-- language_icon = true,
-- language_name = true,
-- language_info = true,
-- language_pad = 0,
-- disable_background = { 'diff' },
-- width = 'full',
-- left_margin = 0,
-- left_pad = 0,
-- right_pad = 0,
-- min_width = 0,
-- border = 'hide',
-- language_border = '█',
-- language_left = '',
-- language_right = '',
-- above = '▄',
-- below = '▀',
-- inline = true,
-- inline_left = '',
-- inline_right = '',
-- inline_pad = 0,
-- highlight = 'RenderMarkdownCode',
-- highlight_info = 'RenderMarkdownCodeInfo',
-- highlight_language = nil,
-- highlight_border = 'RenderMarkdownCodeBorder',
-- highlight_fallback = 'RenderMarkdownCodeFallback',
-- highlight_inline = 'RenderMarkdownCodeInline',
-- style = 'full',
-- },
-- latex = {
-- enabled = true,
-- render_modes = false,
-- converter = 'latex2text',
-- highlight = 'RenderMarkdownMath',
-- position = 'above',
-- top_pad = 0,
-- bottom_pad = 0,
-- },
-- quote = {
-- enabled = true,
-- render_modes = false,
-- icon = '▋',
-- repeat_linebreak = false,
-- highlight = {
-- 'RenderMarkdownQuote1',
-- 'RenderMarkdownQuote2',
-- 'RenderMarkdownQuote3',
-- 'RenderMarkdownQuote4',
-- 'RenderMarkdownQuote5',
-- 'RenderMarkdownQuote6',
-- },
-- },
},
},
}