markdown-preview-ls

A markdown preview tool implementing the language server protocol.

neovim setup

lua/lspconfig/server_configurations/markdown_preview_ls.lua

local util = require('lspconfig.util')
local bin_name = 'markdown-preview-ls'

return {
  default_config = {
    cmd = { bin_name },
    filetypes = { 'markdown' },
    root_dir = util.root_pattern('README.md', '.git'),
  },
  commands = {
    OpenPreview = {
      function()
        vim.lsp.buf.execute_command({
          command = 'mardown-preview.open',
          arguments = { { textDocument = vim.lsp.util.make_text_document_params(0) } },
        })
      end,
      description = 'Open Markdown Preview',
    },
    UpdatePreview = {
      function()
        vim.lsp.buf.execute_command({
          command = 'mardown-preview.update',
          arguments = { { textDocument = vim.lsp.util.make_text_document_params(0) } },
        })
      end,
      description = 'Update Markdown Preview',
    },
    ClosePreview = {
      function()
        vim.lsp.buf.execute_command({
          command = 'mardown-preview.close',
          arguments = {},
        })
      end,
      description = 'Close Markdown Preview',
    },
  },
}

init.lua

require('lspconfig').markdown_preview_ls.setup({})

Switch to focused buffer:

vim.api.nvim_create_autocmd('BufEnter', {
  pattern = { '*.md' },
  command = 'silent! UpdatePreview',
})

Auto scroll preview:

vim.api.nvim_create_autocmd({ 'CursorHold', 'CursorHoldI' }, {
pattern = '*.md',
callback = function()
  local cur = vim.api.nvim_win_get_cursor(0)[1]
  local lines = #vim.api.nvim_buf_get_lines(0, 0, -1, false)
  vim.lsp.buf.execute_command({
    command = 'mardown-preview.scroll',
    arguments = {
      {
        position = (cur - 1) / (lines - 1),
        textDocument = vim.lsp.util.make_text_document_params(0),
      },
    },
  })
end,
})

TODOs

• Scrolling

License

MIT © Josa Gesell