Markdown 预览插件 markdown-preview.nvim
1. 项目介绍
markdown-preview.nvim
是一款专为 Vim 和 Neovim 编辑器设计的 Markdown 预览插件。它使用现代浏览器来渲染预览,支持同步滚动、异步更新以及数学公式(KaTeX)和图表库(如 PlantUML, Mermaid)。该插件跨平台兼容,可在 MacOS、Linux 和 Windows 上运行。
2. 项目快速启动
安装依赖
确保你已经安装了 Node.js 和 Yarn 或者 NPM。
使用 minpac
在你的 .vimrc
文件中添加:
call minpac#add('iamcco/markdown-preview.nvim' ['do': 'packloadall | call mkdp#util#install()'])
然后在 Vim 中执行以下命令完成安装:
:source %
:PluginInstall
:call mkdp#util#install()
使用 Vundle
在 .vimrc
中添加:
Plugin 'iamcco/markdown-preview.nvim'
然后在 Vim 中执行以下命令:
:source %
:PluginInstall
:call mkdp#util#install()
使用 lazy.nvim
在你的 init.lua
或 plugins.lua
文件中加入:
use({
"iamcco/markdown-preview.nvim",
cmd = { "MarkdownPreviewToggle", "MarkdownPreview", "MarkdownPreviewStop" },
ft = { "markdown" },
build = function() vim.fn["mkdp#util#install"]() end,
})
或者如果你想要通过 Yarn 或 NPM 安装,可以这样写:
use({
"iamcco/markdown-preview.nvim",
cmd = { "MarkdownPreviewToggle", "MarkdownPreview", "MarkdownPreviewStop" },
build = "cd app && yarn install",
init = function() vim.g.mkdp_filetypes = {"markdown"} end,
ft = { "markdown" },
})
手动安装
-
克隆仓库到
~/.local/share/nvim/site/pack/packer/start/
目录:cd ~/.local/share/nvim/site/pack/packer/start/ git clone https://github.com/iamcco/markdown-preview.nvim.git
-
在仓库目录下安装依赖:
cd markdown-preview.nvim npx --yes yarn install npx --yes yarn build
-
打开 NVIM 并运行
:PackerInstall
。
3. 应用案例和最佳实践
要启用预览,可以在 Normal 模式下使用 <Plug>MarkdownPreview
命令。要关闭预览,可以使用 <Plug>MarkdownPreviewStop
。为了方便操作,你可以自定义快捷键,例如:
nmap <C-S> <Plug>MarkdownPreview
nmap <M-S> <Plug>MarkdownPreviewStop
为了在 i3 窗口管理器中配置自动布局和焦点设置,你可以在你的 Lua 脚本中增加以下代码:
local peek = require('peek')
vim.api.nvim_create_user_command('PeekOpen', function()
if not peek.is_open() and vim.bo[vim.api.nvim_get_current_buf()]['filetype'] == 'markdown' then
vim.fn.system('i3-msg split horizontal')
peek.open()
end
end, {})
vim.api.nvim_create_user_command('PeekClose', function()
if peek.is_open() then
peek.close()
vim.fn.system('i3-msg move left')
end
end, {})
4. 典型生态项目
该插件可以与其他相关生态结合,比如用于代码高亮的 nvim-tree
,用于文件搜索的 telescope.nvim
,配合它们可以实现更全面的工作流。
nvim-tree
: https://github.com/kyazdani42/nvim-tree.luatelescope.nvim
: https://github.com/nvim-telescope/telescope.nvim
这些工具可以帮助你在编辑 Markdown 文档时更好地浏览文件系统、搜索和跳转文件。