markdown-preview.lua

-- Set to true, nvim will open the preview window after entering the markdown buffer
-- default: false
vim.mkdp_auto_start = true

-- Set to true, nvim will auto close current preview window when change
-- from markdown buffer to another buffer
-- default: true
vim.mkdp_auto_close = true

-- Set to true, the vim will refresh markdown when save the buffer or
-- leave from insert mode, default false is auto refresh markdown as you edit or
-- move the cursor
-- default: false
vim.mkdp_refresh_slow = false

-- Set to true, the MarkdownPreview command can be used for all files,
-- by default it can be used in markdown files
-- default: false
vim.mkdp_command_for_global = false

-- Set to true, preview server available to others in your network
-- by default, the server listens on localhost (127.0.0.1)
-- default: false
vim.mkdp_open_to_the_world = false

-- Use custom IP to open preview page
-- useful when you work in remote vim and preview on local browser
-- more detail see: https://github.com/iamcco/markdown-preview.nvim/pull/9
-- default: empty string
vim.mkdp_open_ip = ''

-- Specify browser to open preview page
-- for path with space
-- valid: `/path/with\ space/xxx`
-- invalid: `/path/with\\ space/xxx`
-- default: ''
vim.mkdp_browser = 'usr/bin/firefox'

-- Set to true, echo preview page url in command line when open preview page
-- default is false
vim.mkdp_echo_preview_url = false

-- A custom vim function name to open preview page
-- this function will receive url as param
-- default is empty
vim.mkdp_browserfunc = ''

-- Options for markdown render
-- mkit: markdown-it options for render
-- katex: katex options for math
-- uml: markdown-it-plantuml options
-- maid: mermaid options
-- disable_sync_scroll: if disable sync scroll, default false
-- sync_scroll_type: 'middle', 'top' or 'relative', default value is 'middle'
--   middle: mean the cursor position always show at the middle of the preview page
--   top: mean the vim top viewport always show at the top of the preview page
--   relative: mean the cursor position always show at the relative position of the preview page
-- hide_yaml_meta: if hide yaml metadata, default is true
-- sequence_diagrams: js-sequence-diagrams options
-- content_editable: if enable content editable for preview page, default: false
-- disable_filename: if disable filename header for preview page, default: false
vim.mkdp_preview_options = {
    mkit = {},
    katex = {},
    uml = {},
    maid = {},
    disable_sync_scroll = false,
    sync_scroll_type = 'middle',
    hide_yaml_meta = true,
    sequence_diagrams = {},
    flowchart_diagrams = {},
    content_editable = false,
    disable_filename = false,
    toc = {}
}

-- Use a custom markdown style (must be absolute path)
-- like '/Users/username/markdown.css' or vim.fn.expand('~/markdown.css')
vim.mkdp_markdown_css = ''

-- Use a custom highlight style (must be absolute path)
-- like '/Users/username/highlight.css' or vim.fn.expand('~/highlight.css')
vim.mkdp_highlight_css = ''

-- Use a custom port to start server or empty for random
vim.mkdp_port = ''

-- Preview page title
-- ${name} will be replaced with the file name
vim.mkdp_page_title = '「${name}」'

-- Recognized filetypes
-- these filetypes will have MarkdownPreview... commands
vim.mkdp_filetypes = {'markdown'}

-- Set default theme (dark or light)
-- By default the theme is defined according to the preferences of the system
vim.mkdp_theme = 'dark'