Skip to content

Commit

Permalink
docs(beginners guide): add plugins overview (LunarVim#413)
Browse files Browse the repository at this point in the history
* Added plugins overview and details to beginner's guide

Added plugins overview and details about core plugins to beginner's guide / plugins-overview

* Removed table from core plugins to eliminate repetition

* Update expect.txt
  • Loading branch information
MemerGamer authored Jun 21, 2023
1 parent 7a322c5 commit e54d2fb
Show file tree
Hide file tree
Showing 2 changed files with 51 additions and 1 deletion.
2 changes: 2 additions & 0 deletions .github/actions/spelling/expect.txt
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ fzf
fzy
Github
gitignored
Gitsigns
highlighter
hrsh
hsl
Expand Down Expand Up @@ -40,3 +41,4 @@ vheight
vimgrep
vsplit
winseparator
workflow
50 changes: 49 additions & 1 deletion docs/beginners-guide/plugins-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,52 @@ sidebar_position: 2

# Plugins overview

This page is not written yet, [you can help us write it](https://github.com/LunarVim/lunarvim.org/issues/352)
LunarVim supports a wide range of plugins to enhance the functionality of the Neovim text editor. This guide will introduce you to the basic core plugins that are part of LunarVim.

## Core plugins

LunarVim also includes a set of [core plugins](../../features/core-plugins-list) that are pre-configured and provided out of the box. These plugins offer essential features and functionality.

These plugins are just a starting point, and there are many more available to explore. Remember to read the documentation and experiment with different plugins to find the ones that suit your workflow and preferences.

## Core plugin details

### Neovim LSP Configuration

The `nvim-lspconfig` plugin provides easy configuration for the built-in Language Server Protocol (LSP) client in Neovim. It simplifies the setup process for various language servers, enabling features like code completion, linting, and more.

### nvim-treesitter

`nvim-treesitter` brings advanced syntax highlighting and parsing capabilities to Neovim. It improves code highlighting accuracy, enables better indentation, and allows for various language-specific features.

### Telescope

`Telescope` is a highly extensible fuzzy finder plugin. It provides a powerful interface for searching files, buffers, and other resources within your Neovim environment. With its intuitive navigation and customizable options, it simplifies the process of finding and opening files.

### NERDTree

For a more traditional file explorer experience, `NERDTree` is a popular plugin. It provides a sidebar that displays the directory structure, allowing you to navigate and manage files easily. This plugin is especially useful if you prefer a visual representation of your project's files.

### Auto Pairs

`Auto Pairs` automatically inserts matching pairs of brackets, quotes, and other characters as you type. It saves time and reduces the chances of mismatched pairs. This plugin greatly enhances the editing experience and helps prevent syntax errors.

### Comment.nvim

`Comment.nvim` simplifies the process of commenting and uncommenting code blocks. It supports various programming languages and provides keybindings for quickly toggling comments. This plugin makes it easy to annotate your code and improve readability.

### Gitsigns

If you're using Git for version control, `Gitsigns` is a valuable plugin. It displays Git diff markers and signs within the gutter, indicating added, modified, or deleted lines. This helps you visualize changes and track the status of your files directly in Neovim.

### Lualine

`Lualine` is a customizable statusline plugin for Neovim. It allows you to display various information, such as the current mode, file path, and Git branch, in your statusline. With its simple configuration, you can personalize the appearance and contents of your statusline.

### Which-key

`Which-key` provides a popup that shows keybindings and their associated commands. It helps you discover and remember available keybindings within Neovim. This plugin is particularly useful for beginners who want to explore and learn the various functionalities offered by Neovim and its plugins.

## Installing and configuring plugins

Plugins in LunarVim are managed using [folke/lazy.nvim](https://github.com/folke/lazy.nvim). To install plugins, you need to add entries to the `lvim.plugins` table in your `config.lua`. About configuring your plugins you can read a lot more at [this page](../../configuration/plugins).

0 comments on commit e54d2fb

Please sign in to comment.