peek.nvim 项目教程

peek.nvim 项目教程

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

1. 项目的目录结构及介绍

peek.nvim 项目的目录结构如下：

peek.nvim/
├── lua/
│   ├── peek/
│   │   ├── init.lua
│   │   ├── config.lua
│   │   ├── preview.lua
│   │   └── utils.lua
├── plugin/
│   └── peek.vim
├── README.md
└── LICENSE

目录介绍：

• lua/: 包含所有 Lua 脚本文件，是项目的主要逻辑部分。
  • peek/: 包含 peek.nvim 的核心功能模块。
    • init.lua: 项目的初始化文件。
    • config.lua: 配置文件处理模块。
    • preview.lua: 预览功能实现模块。
    • utils.lua: 工具函数模块。
• plugin/: 包含 Vim 插件文件，用于在 Neovim 中加载 peek.nvim。
• README.md: 项目说明文档。
• LICENSE: 项目许可证文件。

2. 项目的启动文件介绍

项目的启动文件是 lua/peek/init.lua。该文件负责初始化 peek.nvim 插件，并加载必要的模块和配置。

启动文件主要功能：

• 加载配置文件 config.lua。
• 初始化预览功能 preview.lua。
• 设置插件的命令和快捷键。

3. 项目的配置文件介绍

项目的配置文件是 lua/peek/config.lua。该文件定义了 peek.nvim 的默认配置选项，并提供了用户自定义配置的接口。

配置文件主要内容：

• auto_load: 是否自动加载预览。
• close_on_bdelete: 是否在缓冲区删除时关闭预览窗口。
• syntax: 是否启用语法高亮。
• theme: 预览窗口的主题（'dark' 或 'light'）。
• update_on_change: 是否在文件更改时自动更新预览。
• app: 预览窗口的应用程序（'webview' 或 'browser'）。
• filetype: 识别为 Markdown 的文件类型列表。
• throttle_at: 开始节流时的文件大小。
• throttle_time: 节流时间。

用户可以通过以下方式自定义配置：

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'
})

以上是 peek.nvim 项目的目录结构、启动文件和配置文件的详细介绍。希望这份教程能帮助你更好地理解和使用 peek.nvim 插件。

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