lexy.nvim

Caution

Status: Under development.

ℹ️ About

lexy.nvim is a Neovim plugin for working with local Lexy documentation inside the editor. It is intended to connect Lexy's cached Learn X in Y Minutes files with familiar Neovim workflows and picker UIs.

🎬 Demo

✨ Features

• Integrates local Lexy documentation into Neovim
• Registers a :LexySearch {query}, :LexyUpdate and a :LexyList user command
• Provides a configurable keymap hook for :LexyList command
• Reads documentation from Lexy's local cache in ~/.config/lexy/files/
• Integration with snacks.nvim, telescope.nvim and mini.pick

📋 Requirements

lexy.nvim requires Neovim 0.11 or newer and a working Lexy installation. Since the plugin reads Lexy's local cache, you should run Lexy at least once so the files under ~/.config/lexy/files/ exist.

To use a picker UI, install either snacks.nvim or telescope.nvim.

📦 Installation

vim.pack

vim.schedule(function()
	vim.pack.add({ "https://github.com/antoniorodr/lexy.nvim" })
	require("lexy").setup()
end)

lazy.nvim

{
  "antoniorodr/lexy.nvim",
  dependencies = {
    "folke/snacks.nvim", -- or "nvim-telescope/telescope.nvim" or "echasnovski/mini.pick"
  },
  opts = {} -- see Configuration section below if you want to customize the plugin
}

🚀 Getting Started

Once installed, you can either use the :LexySearch {query}, :LexyUpdate and :LexyList user commands or the default keymap <leader>sll to start searching through your local Lexy documentation and <leader>slu to update and fetch new documentation if available. The plugin will read from the cached files in ~/.config/lexy/files/ and present results in a picker UI if you have one of the supported picker plugins installed.

Tip

It's a good idea to run :checkhealth snacks to see if everything is set up correctly.

🛠️ Configuration

The plugin provides a setup function that accepts a configuration table for customize the keymaps. For example:

require("lexy").setup({
    keymaps = {
        search = "<leader>ls",
        update = "<leader>lu",
    },
})

❤️ Do you like my work?

If you find the project useful, you can support the author here: