mini.nvim

<p align="center"> <img src="logo.svg" alt="mini.nvim" style="max-width:100%;border:solid 2px"/> </p>

### All-in-one plugin

Library of 45+ independent Lua modules improving overall [Neovim](https://github.com/neovim/neovim) (version 0.10 and higher) experience with minimal effort. They all share same configuration approaches and general design principles.

Think about this project as "Swiss Army knife" among Neovim plugins: it has many different independent tools (modules) suitable for most common tasks. Each module can be used separately without any startup and usage overhead.

If you want to help this project grow but don't know where to start:

- Leave a Github star for 'mini.nvim' and/or any other [MINI projects](https://nvim-mini.org).
- Check out [contributing guides](CONTRIBUTING.md).

See [change log](CHANGELOG.md) for a history of changes, including current development version.

See [MiniMax](https://nvim-mini.org/MiniMax) for a full config example based on 'mini.nvim'.

> [!NOTE]
> This was previously hosted at `echasnovski/mini.nvim`. It was transferred to a dedicated organization to improve long term project stability. See more details [here](https://github.com/nvim-mini/mini.nvim/discussions/1970).

## Table of contents

- [Installation](#installation)
- [Modules](#modules)
- [General principles](#general-principles)
- [Plugin color schemes](#plugin-color-schemes)
- [Planned modules](#planned-modules)

## Installation

There are two branches to install from:

- `main` (default, **recommended**) will have latest development version of plugin. All changes since last stable release should be perceived as being in beta testing phase (meaning they already passed alpha-testing and are moderately settled).
- `stable` will be updated only upon releases with code tested during public beta-testing phase in `main` branch.

Here are code snippets for some common installation methods:

- (**Recommended**) With [vim.pack](https://neovim.io/doc/user/helptag.html?tag=vim.pack) (on Neovim 0.12 and newer):

    - Main branch:

        ```lua
        vim.pack.add({ 'https://github.com/nvim-mini/mini.nvim' })
        ```

    - Stable branch:

        ```lua
        vim.pack.add({
          { src = 'https://github.com/nvim-mini/mini.nvim', version = 'stable' },
        })
        ```

- Manually with `git clone` (compatible with [mini.deps](https://nvim-mini.org/mini.nvim/readmes/mini-deps)):

    ```lua
    -- Put this at the top of 'init.lua'
    local path_package = vim.fn.stdpath('data') .. '/site'
    local mini_path = path_package .. '/pack/deps/start/mini.nvim'
    if not vim.uv.fs_stat(mini_path) then
      vim.cmd('echo "Installing `mini.nvim`" | redraw')
      local clone_cmd = {
        'git', 'clone', '--filter=blob:none',
        -- Uncomment next line to use 'stable' branch
        -- '--branch', 'stable',
        'https://github.com/nvim-mini/mini.nvim', mini_path
      }
      vim.fn.system(clone_cmd)
      vim.cmd('packadd mini.nvim |