Skip to content

README.md

Latest commit

 

History

History
42 lines (31 loc) · 883 Bytes

README.md

File metadata and controls

42 lines (31 loc) · 883 Bytes
Raw

sql-docs.nvim

A Neovim plugin that provides SQL documentation when pressing K over SQL keywords.

Features

  • Shows documentation for common SQL keywords
  • Displays syntax information
  • Includes examples for complex keywords
  • Closes with 'q' or 'Esc'
  • Only activates in SQL files by default

Installation

Using lazy.nvim

{
  "adtyap26/sql_docs.nvim",
  lazy = false,
  config = function()
    require("sql-docs").setup()
  end
}

Configuration

You can customize the plugin with the following options:

require("sql-docs").setup({
  filetypes = {"sql", "mysql", "pgsql"}, -- Filetypes where the plugin is active
  mapping = "K", -- Key mapping to trigger documentation
})

Usage

  1. Open a SQL file
  2. Place your cursor over a SQL keyword (e.g., SELECT, FROM, WHERE)
  3. Press K to view documentation