peek.nvim 使用教程

peek.nvim 使用教程

peek.nvimMarkdown preview plugin for Neovim项目地址:https://gitcode.com/gh_mirrors/pe/peek.nvim

1、项目介绍

peek.nvim 是一款专为 Neovim 设计的 Markdown 预览插件。它提供了实时更新、同步滚动、美观的 GitHub 风格界面，以及支持 TeX 数学公式和 Mermaid 图表。通过 Deno 运行，它无缝集成到 Neovim 环境中，让您的文本编辑器变得更加智能。

2、项目快速启动

安装

您可以通过 NeoVim 插件管理器进行安装，只需一行代码：

Plug 'toppair/peek.nvim'

配置

以下是默认配置示例：

require('peek').setup({
  auto_load = true,
  close_on_bdelete = true,
  syntax = true,
  theme = 'dark',
  update_on_change = true,
  app = 'webview',
  filetype = { 'markdown' },
  throttle_at = 200000,
  throttle_time = 'auto'
})

使用

打开预览窗口：

:PeekOpen

关闭预览窗口：

:PeekClose

3、应用案例和最佳实践

撰写博客

peek.nvim 的实时预览功能特别适合撰写博客，您可以即时查看和调整格式，确保博客内容的呈现效果。

编写文档

对于复杂的学术论文和技术文档编写，peek.nvim 的支持 TeX 和 Mermaid 功能使得编写更加便捷。

协作开发

peek.nvim 提供了一套灵活的配置选项，可以轻松调整预览窗口的行为和外观，以适应不同的工作流和个人喜好。

4、典型生态项目

Neovim

peek.nvim 是专为 Neovim 设计的插件，与 Neovim 无缝集成，提供强大的文本编辑体验。

Deno

peek.nvim 通过 Deno 运行，利用 Deno 的强大功能和安全性，确保插件的稳定性和性能。

KaTeX

peek.nvim 利用 KaTeX 库渲染数学公式，提供高质量的数学公式显示效果。

Mermaid

peek.nvim 支持 Mermaid 图表，允许您在 Markdown 中绘制流程图和序列图，增强文档的可视化效果。

通过以上内容，您可以快速上手并充分利用 peek.nvim 的功能，提升您的 Markdown 编写体验。

peek.nvimMarkdown preview plugin for Neovim项目地址:https://gitcode.com/gh_mirrors/pe/peek.nvim