https://github.com/selectnull/plugin-readme.nvim

Lists Neovim plugins (installed by Lazy.nvim) and shows README files.
https://github.com/selectnull/plugin-readme.nvim

neovim neovim-plugin

Last synced: 4 months ago
JSON representation

Lists Neovim plugins (installed by Lazy.nvim) and shows README files.

• Host: GitHub
• URL: https://github.com/selectnull/plugin-readme.nvim
• Owner: selectnull
• License: mit
• Created: 2024-09-13T09:24:06.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2024-09-13T19:25:14.000Z (over 1 year ago)
• Last Synced: 2025-09-23T19:52:17.561Z (4 months ago)
• Topics: neovim, neovim-plugin
• Language: Lua
• Homepage:
• Size: 2.93 KB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# plugin-readme

When you mess with the Neovim configuration (instead of working),

it's often needed to read the plugin documentation. This plugin

attempts to make that easier.

List all installed plugins and preview their README file.

Press ENTER and open the plugin github repository in a browser.

## Requirements

* Neovim >= 0.10 (haven't tested it with lower versions)

* Lazy.nvim

## Installation

For now, it supports only `lazy.nvim`.

    {

        "selectnull/plugin-readme.nvim",

        dependencies = {

            "nvim-telescope/telescope.nvim",

        },

        config = function()

            local readme = require "plugin-readme"

            vim.keymap.set("n", "p", readme.select_plugin, {})

        end,

    }