https://github.com/tldr-pages/tldr-neovim-extension

TLDR Neovim Extension is a plugin that integrates TLDR pages directly into Neovim.
https://github.com/tldr-pages/tldr-neovim-extension

hacktoberfest lua neovim neovim-telescope-extension nvim tldr tldr-pages

Last synced: about 1 month ago
JSON representation

TLDR Neovim Extension is a plugin that integrates TLDR pages directly into Neovim.

• Host: GitHub
• URL: https://github.com/tldr-pages/tldr-neovim-extension
• Owner: tldr-pages
• License: mit
• Created: 2022-12-16T13:35:23.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-02-20T07:45:15.000Z (7 months ago)
• Last Synced: 2024-04-16T09:05:35.206Z (5 months ago)
• Topics: hacktoberfest, lua, neovim, neovim-telescope-extension, nvim, tldr, tldr-pages
• Language: Lua
• Homepage:
• Size: 21.5 KB
• Stars: 5
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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

```lua

use {

    'tldr-pages/tldr-neovim-extension',

    requires = {

        'nvim-telescope/telescope.nvim'

    },

}

```

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:

```lua

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. Use the following commands to interact with the plugin:

```

:Tldr : Open a TLDR page for a specific topic.

:Tldr: List all available TLDR pages in a Telescope window.

:TldrUpdate: Update the local TLDR repository to get the latest 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.