tldr-neovim-extension

TLDR Neovim Extension is a plugin that integrates TLDR pages directly into Neovim. TLDR is a community-driven collection of simplified and community-contributed man pages. This plugin allows you to access TLDR pages directly from within Neovim, making it easier to find concise explanations and examples for various commands.

Installation

Using Packer

Add the following line to your Neovim configuration file

use {
    'tldr-pages/tldr-neovim-extension',
    -- Optional: Choose one of these pickers (or neither for basic functionality)
    requires = {
        'nvim-telescope/telescope.nvim'  -- OR
        -- 'echasnovski/mini.pick'
    },
}

Save the configuration file and restart Neovim.

Run the following command in Neovim to install the plugin:

:PackerInstall

Once the installation is complete, add the following line to your configuration to enable the plugin:

require('tldr').setup()

This line should be placed after the use statement for the plugin in your configuration file.

Save the configuration file, and the TLDR Neovim Extension will be active the next time you start Neovim.

Usage

Once the plugin is installed and set up, you can access TLDR pages from within Neovim. The plugin supports multiple picker backends:

Commands

:Tldr <topic>: Open a TLDR page for a specific topic.
:Tldr: List all available TLDR pages using the available picker.
:TldrUpdate: Update the local TLDR repository to get the latest pages.
:Pick tldr: Use mini.pick to browse TLDR pages (if mini.pick is installed).

Picker Support

The plugin automatically detects and uses available pickers in the following priority order:

1. Telescope (if telescope.nvim is installed)
2. Mini.pick (if mini.pick is installed)
3. None - Basic functionality still works with :Tldr <command>

If you have mini.pick installed, you can also use :Pick tldr to browse TLDR pages.

Contributions

We welcome contributions to the TLDR Neovim Extension! If you'd like to help improve the plugin or have ideas for new features, please don't hesitate to get involved. Here's how you can contribute:

• Fork this repository.
• Make your changes or add new features.
• Submit a pull request with a clear description of your changes.