retrovim 0.0.3

package/nvim/plugins/mini.nvim/readmes/mini-diff.md

@@ -0,0 +1,289 @@
+<p align="center"> <img src="https://github.com/nvim-mini/assets/blob/main/logo-2/logo-diff_readme.png?raw=true" alt="mini.diff" style="max-width:100%;border:solid 2px"/> </p>
+
+### Work with diff hunks
+
+See more details in [Features](#features) and [Documentation](../doc/mini-diff.txt).
+
+---
+
+> [!NOTE]
+> This was previously hosted at a personal `echasnovski` GitHub account. 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).
+
+⦿ This is a part of [mini.nvim](https://nvim-mini.org/mini.nvim) library. Please use [this link](https://nvim-mini.org/mini.nvim/readmes/mini-diff) if you want to mention this module.
+
+⦿ All contributions (issues, pull requests, discussions, etc.) are done inside of 'mini.nvim'.
+
+⦿ See [whole library documentation](https://nvim-mini.org/mini.nvim/doc/mini-nvim) to learn about general design principles, disable/configuration recipes, and more.
+
+⦿ See [MiniMax](https://nvim-mini.org/MiniMax) for a full config example that uses this module.
+
+---
+
+If you want to help this project grow but don't know where to start, check out [contributing guides of 'mini.nvim'](https://nvim-mini.org/mini.nvim/CONTRIBUTING) or leave a Github star for 'mini.nvim' project and/or any its standalone Git repositories.
+
+## Demo
+
+<!-- Demo source: https://github.com/nvim-mini/assets/blob/main/demo/demo-diff.mp4 -->
+https://github.com/nvim-mini/mini.nvim/assets/24854248/77849127-ee9f-430b-9eff-5a8a724c21ea
+
+## Features
+
+- Visualize difference between buffer text and its configurable reference interactively (updates as you type). This is done per line showing whether it is inside added, changed, or deleted part of difference (called hunk). Visualization can be with customizable colored signs or line numbers.
+
+- Special toggleable overlay view with more hunk details inside text area.
+
+- Completely configurable per buffer source(s) of reference text used to keep it up to date and define interactions with it. Can be array of sources which are attempted to attach in order. By default uses Git source (buffer's file text from Git index as reference).
+
+- Configurable mappings to manage diff hunks:
+    - Apply and reset hunks inside region (selected visually or with a dot-repeatable operator).
+    - "Hunk range under cursor" textobject to be used as operator target.
+    - Navigate to first/previous/next/last hunk.
+
+What it doesn't do:
+
+- Provide functionality to work directly with Git outside of visualizing and staging (applying) hunks with (default) Git source. In particular, unstaging hunks is not supported.
+
+For more information see these parts of help:
+
+- `:h MiniDiff-overview`
+- `:h MiniDiff-source-specification`
+- `:h MiniDiff-hunk-specification`
+- `:h MiniDiff-diff-summary`
+
+## Overview
+
+### Diffs and hunks
+
+The "diff" (short for "difference") is a result of computing how two text strings differ from one another. This is done on per line basis, i.e. the goal is to compute sequences of lines common to both files, interspersed with groups of differing lines (called "hunks").
+
+Although computing diff is a general concept (used on its own, in Git, etc.), this module computes difference between current text in a buffer and some reference text which is kept up to date specifically for that buffer. For example, default reference text is computed as file content in Git index. This can be customized in `config.source`.
+
+### Life cycle
+
+- When entering proper (not already enabled, valid, showing text) buffer, it is attempted to be enabled for diff processing.
+- During enabling, attempt attaching the source. This should set up how reference text is kept up to date.
+- On every text change, diff computation is scheduled in debounced fashion after customizable delay (200 ms by default).
+- After the diff is computed, do the following:
+    - Update visualization based on configurable style: either by placing colored text in sign column or coloring line numbers. Colors for both styles are defined per hunk type in corresponding `MiniDiffSign*` highlight group and sign text for "sign" style can be configured in `config.view.signs`.
+    - Update overlay view (if it is enabled).
+    - Update `vim.b.minidiff_summary` and `vim.b.minidiff_summary_string` buffer-local variables. These can be used, for example, in statusline.
+    - Trigger `MiniDiffUpdated` `User` event. See `:h MiniDiff-diff-summary` for example of how to use it.
+
+Notes:
+
+- Use `:edit` to reset (disable and re-enable) current buffer.
+
+### Overlay
+
+Along with basic visualization, there is a special view called "overlay". Although it is meant for temporary overview of diff details and can be manually toggled via `MiniDiff.toggle_overlay()`, text can be changed with overlay reacting accordingly.
+
+It shows more diff details inside text area:
+
+- Added buffer lines are highlighted with `MiniDiffOverAdd` highlight group.
+- Deleted reference lines are shown as virtual text and highlighted with `MiniDiffOverDelete` highlight group.
+- Changed reference lines are shown as virtual text and highlighted with `MiniDiffOverChange` highlight group.
+
+  "Change" hunks with equal number of buffer and reference lines have special treatment and show "word diff". Reference line is shown next to its buffer counterpart and only changed parts of both lines are highlighted with `MiniDiffOverChange`. The rest of reference line has `MiniDiffOverContext` highlighting.
+
+  This usually is the case when `config.options.linematch` is enabled.
+
+### Mappings
+
+This module provides mappings for common actions with diffs, like:
+
+- Apply and reset hunks.
+- "Hunk range under cursor" textobject.
+- Go to first/previous/next/last hunk range.
+
+Examples:
+
+- `vip` followed by `gh` / `gH` applies/resets hunks inside current paragraph. Same can be achieved in operator form `ghip` / `gHip`, which has the advantage of being dot-repeatable.
+- `gh_` / `gH_` applies/resets current line (even if it is not a full hunk).
+- `ghgh` / `gHgh` applies/resets hunk range under cursor.
+- `dgh` deletes hunk range under cursor.
+- `[H` / `[h` / `]h` / `]H` navigate cursor to the first / previous / next / last hunk range of the current buffer.
+
+Mappings for some functionality are assumed to be done manually. See `:h MiniDiff.operator()`.
+
+### Buffer-local variables
+
+Each enabled buffer has the following buffer-local variables which can be used in custom statusline to show an overview of hunks in current buffer:
+
+- `vim.b.minidiff_summary` is a table with the following fields:
+    - `source_name` - name of the source.
+    - `n_ranges` - number of hunk ranges (sequences of contiguous hunks).
+    - `add` - number of added lines.
+    - `change` - number of changed lines.
+    - `delete` - number of deleted lines.
+
+- `vim.b.minidiff_summary_string` is a string representation of summary with a fixed format. It is expected to be used as is. To achieve different formatting, use `vim.b.minidiff_summary` to construct one. The best way to do this is by overriding `vim.b.minidiff_summary_string` in the callback for `MiniDiffUpdated` event:
+
+    ```lua
+    local format_summary = function(data)
+      local summary = vim.b[data.buf].minidiff_summary
+      local t = {}
+      if summary.add > 0 then table.insert(t, '+' .. summary.add) end
+      if summary.change > 0 then table.insert(t, '~' .. summary.change) end
+      if summary.delete > 0 then table.insert(t, '-' .. summary.delete) end
+      vim.b[data.buf].minidiff_summary_string = table.concat(t, ' ')
+    end
+    local au_opts = { pattern = 'MiniDiffUpdated', callback = format_summary }
+    vim.api.nvim_create_autocmd('User', au_opts)
+    ```
+
+## Installation
+
+This plugin can be installed as part of 'mini.nvim' library (**recommended**) or as a standalone Git repository.
+
+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 (use only one):
+
+<details>
+<summary><b>(Recommended)</b> With <a href="https://neovim.io/doc/user/helptag.html?tag=vim.pack">vim.pack</a> (on Neovim 0.12 and newer)</summary>
+
+**Full library**
+
+Follow ['mini.nvim' installation](https://nvim-mini.org/mini.nvim#installation).
+
+**Standalone plugin**
+
+Main branch:
+
+```lua
+vim.pack.add({ 'https://github.com/nvim-mini/mini.diff' })
+```
+
+Stable branch:
+
+```lua
+vim.pack.add({
+  { src = 'https://github.com/nvim-mini/mini.diff', version = 'stable' },
+})
+```
+
+</details>
+
+<details>
+<summary>With <a href="https://nvim-mini.org/mini.nvim/readmes/mini-deps">mini.deps</a> (before Neovim 0.12)</summary>
+
+**Full library**
+
+Follow [recommended 'mini.deps' installation](https://nvim-mini.org/mini.nvim/readmes/mini-deps#installation).
+
+**Standalone plugin**:
+
+Main branch:
+
+```lua
+add('nvim-mini/mini.diff')
+```
+
+Stable branch:
+
+```lua
+add({ source = 'nvim-mini/mini.diff', checkout = 'stable' })
+```
+
+</details>
+
+<details>
+<summary>With <a href="https://github.com/folke/lazy.nvim">folke/lazy.nvim</a></summary>
+
+**Full library**
+
+Follow ['mini.nvim' installation](https://nvim-mini.org/mini.nvim#installation).
+
+**Standalone plugin**
+
+Main branch:
+
+```lua
+{ 'nvim-mini/mini.diff', version = false },
+```
+
+Stable branch:
+
+```lua
+{ 'nvim-mini/mini.diff', version = '*' },
+```
+
+</details>
+
+**Important**: don't forget to call `require('mini.diff').setup()` to enable its functionality.
+
+**Note**: if you are on Windows, there might be problems with too long file paths (like `error: unable to create file <some file name>: Filename too long`). Try doing one of the following:
+
+- Enable corresponding git global config value: `git config --system core.longpaths true`. Then try to reinstall.
+- Install plugin in other place with shorter path.
+
+## Default config
+
+```lua
+-- No need to copy this inside `setup()`. Will be used automatically.
+{
+  -- Options for how hunks are visualized
+  view = {
+    -- Visualization style. Possible values are 'sign' and 'number'.
+    -- Default: 'number' if line numbers are enabled, 'sign' otherwise.
+    style = vim.go.number and 'number' or 'sign',
+
+    -- Signs used for hunks with 'sign' view
+    signs = { add = '▒', change = '▒', delete = '▒' },
+
+    -- Priority of used visualization extmarks
+    priority = 199,
+  },
+
+  -- Source(s) for how reference text is computed/updated/etc
+  -- Uses content from Git index by default
+  source = nil,
+
+  -- Delays (in ms) defining asynchronous processes
+  delay = {
+    -- How much to wait before update following every text change
+    text_change = 200,
+  },
+
+  -- Module mappings. Use `''` (empty string) to disable one.
+  mappings = {
+    -- Apply hunks inside a visual/operator region
+    apply = 'gh',
+
+    -- Reset hunks inside a visual/operator region
+    reset = 'gH',
+
+    -- Hunk range textobject to be used inside operator
+    -- Works also in Visual mode if mapping differs from apply and reset
+    textobject = 'gh',
+
+    -- Go to hunk range in corresponding direction
+    goto_first = '[H',
+    goto_prev = '[h',
+    goto_next = ']h',
+    goto_last = ']H',
+  },
+
+  -- Various options
+  options = {
+    -- Diff algorithm (see `:h vim.text.diff()`)
+    algorithm = 'histogram',
+
+    -- Whether to use "indent heuristic" (see `:h vim.text.diff()`)
+    indent_heuristic = true,
+
+    -- The amount of second-stage diff to align lines
+    linematch = 60,
+
+    -- Whether to wrap around edges during hunk navigation
+    wrap_goto = false,
+  },
+}
+```
+
+## Similar plugins
+
+- [lewis6991/gitsigns.nvim](https://github.com/lewis6991/gitsigns.nvim)

package/nvim/plugins/mini.nvim/readmes/mini-doc.md

@@ -0,0 +1,198 @@
+<p align="center"> <img src="https://github.com/nvim-mini/assets/blob/main/logo-2/logo-doc_readme.png?raw=true" alt="mini.doc" style="max-width:100%;border:solid 2px"/> </p>
+
+### Generation of help files from EmmyLua-like annotations
+
+See more details in [Features](#features) and [Documentation](../doc/mini-doc.txt).
+
+---
+
+> [!NOTE]
+> This was previously hosted at a personal `echasnovski` GitHub account. 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).
+
+⦿ This is a part of [mini.nvim](https://nvim-mini.org/mini.nvim) library. Please use [this link](https://nvim-mini.org/mini.nvim/readmes/mini-doc) if you want to mention this module.
+
+⦿ All contributions (issues, pull requests, discussions, etc.) are done inside of 'mini.nvim'.
+
+⦿ See [whole library documentation](https://nvim-mini.org/mini.nvim/doc/mini-nvim) to learn about general design principles, disable/configuration recipes, and more.
+
+---
+
+If you want to help this project grow but don't know where to start, check out [contributing guides of 'mini.nvim'](https://nvim-mini.org/mini.nvim/CONTRIBUTING) or leave a Github star for 'mini.nvim' project and/or any its standalone Git repositories.
+
+## Demo
+
+<!-- Demo source: https://github.com/nvim-mini/assets/blob/main/demo/demo-doc.mp4 -->
+https://user-images.githubusercontent.com/24854248/173044513-755dec35-4f6c-4a51-aa96-5e380f6d744f.mp4
+
+## Features
+
+- Keep documentation next to code by writing EmmyLua-like annotation comments. They will be parsed as is, so formatting should follow built-in guide. However, custom hooks are allowed at many generation stages for more granular management of output help file.
+- Generation is done by processing a set of ordered files line by line. Each line can either be considered as a part of documentation block (if it matches certain configurable pattern) or not (considered to be an "afterline" of documentation block). See `MiniDoc.generate()` help for more details.
+- Processing is done by using nested data structures (section, block, file, doc) describing certain parts of help file. See `MiniDoc-data-structures` help page for more details.
+- Allow flexible customization of output via hook functions.
+- Project specific script can be written as plain Lua file with configuratble path. See `MiniDoc.generate()` help for more details.
+
+## Installation
+
+This plugin can be installed as part of 'mini.nvim' library (**recommended**) or as a standalone Git repository.
+
+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 (use only one):
+
+<details>
+<summary><b>(Recommended)</b> With <a href="https://neovim.io/doc/user/helptag.html?tag=vim.pack">vim.pack</a> (on Neovim 0.12 and newer)</summary>
+
+**Full library**
+
+Follow ['mini.nvim' installation](https://nvim-mini.org/mini.nvim#installation).
+
+**Standalone plugin**
+
+Main branch:
+
+```lua
+vim.pack.add({ 'https://github.com/nvim-mini/mini.doc' })
+```
+
+Stable branch:
+
+```lua
+vim.pack.add({
+  { src = 'https://github.com/nvim-mini/mini.doc', version = 'stable' },
+})
+```
+
+</details>
+
+<details>
+<summary>With <a href="https://nvim-mini.org/mini.nvim/readmes/mini-deps">mini.deps</a> (before Neovim 0.12)</summary>
+
+**Full library**
+
+Follow [recommended 'mini.deps' installation](https://nvim-mini.org/mini.nvim/readmes/mini-deps#installation).
+
+**Standalone plugin**:
+
+Main branch:
+
+```lua
+add('nvim-mini/mini.doc')
+```
+
+Stable branch:
+
+```lua
+add({ source = 'nvim-mini/mini.doc', checkout = 'stable' })
+```
+
+</details>
+
+<details>
+<summary>With <a href="https://github.com/folke/lazy.nvim">folke/lazy.nvim</a></summary>
+
+**Full library**
+
+Follow ['mini.nvim' installation](https://nvim-mini.org/mini.nvim#installation).
+
+**Standalone plugin**
+
+Main branch:
+
+```lua
+{ 'nvim-mini/mini.doc', version = false },
+```
+
+Stable branch:
+
+```lua
+{ 'nvim-mini/mini.doc', version = '*' },
+```
+
+</details>
+
+**Important**: don't forget to call `require('mini.doc').setup()` to enable its functionality.
+
+**Note**: if you are on Windows, there might be problems with too long file paths (like `error: unable to create file <some file name>: Filename too long`). Try doing one of the following:
+
+- Enable corresponding git global config value: `git config --system core.longpaths true`. Then try to reinstall.
+- Install plugin in other place with shorter path.
+
+## Default config
+
+```lua
+-- No need to copy this inside `setup()`. Will be used automatically.
+{
+  -- Lua string pattern to determine if line has documentation annotation.
+  -- First capture group should describe possible section id. Default value
+  -- means that annotation line should:
+  -- - Start with `---` at first column.
+  -- - Any non-whitespace after `---` will be treated as new section id.
+  -- - Single whitespace at the start of main text will be ignored.
+  annotation_pattern = '^%-%-%-(%S*) ?',
+
+  -- Identifier of block annotation lines until first captured identifier
+  default_section_id = '@text',
+
+  -- Hooks to be applied at certain stage of document life cycle. Should
+  -- modify its input in place (and not return new one).
+  hooks = {
+    -- Applied to block before anything else
+    block_pre = --<function: infers header sections (tag and/or signature)>,
+
+    -- Applied to section before anything else
+    section_pre = --<function: replaces current aliases>,
+
+    -- Applied if section has specified captured id
+    sections = {
+      ['@alias'] = --<function: registers alias in MiniDoc.current.aliases>,
+      ['@class'] = --<function>,
+      -- For most typical usage see |MiniDoc.afterlines_to_code|
+      ['@eval'] = --<function: evaluates lines; replaces with their return>,
+      ['@field'] = --<function>,
+      ['@param'] = --<function>,
+      ['@private'] = --<function: registers block for removal>,
+      ['@return'] = --<function>,
+      ['@seealso'] = --<function>,
+      ['@signature'] = --<function: formats signature of documented object>,
+      ['@tag'] = --<function: turns its line in proper tag lines>,
+      ['@text'] = --<function: purposefully does nothing>,
+      ['@type'] = --<function>,
+      ['@usage'] = --<function>,
+    },
+
+    -- Applied to section after all previous steps
+    section_post = --<function: currently does nothing>,
+
+    -- Applied to block after all previous steps
+    block_post = --<function: does many things>,
+
+    -- Applied to file after all previous steps
+    file = --<function: adds separator>,
+
+    -- Applied to doc after all previous steps
+    doc = --<function: adds modeline>,
+
+    -- Applied before output file is written. Takes lines array as argument.
+    write_pre = --<function: removes delimiters at the top>,
+
+    -- Applied after output help file is written. Takes doc as argument.
+    write_post = --<function: various convenience actions>,
+  },
+
+  -- Path (relative to current directory) to script which handles project
+  -- specific help file generation (like custom input files, hooks, etc.).
+  script_path = 'scripts/minidoc.lua',
+
+  -- Whether to disable showing non-error feedback
+  silent = false,
+}
+```
+
+## Similar plugins
+
+- [tjdevries/tree-sitter-lua](https://github.com/tjdevries/tree-sitter-lua)
+- [numToStr/lemmy-help](https://github.com/numToStr/lemmy-help) (command line tool)

package/nvim/plugins/mini.nvim/readmes/mini-extra.md

@@ -0,0 +1,158 @@
+<p align="center"> <img src="https://github.com/nvim-mini/assets/blob/main/logo-2/logo-extra_readme.png?raw=true" alt="mini.extra" style="max-width:100%;border:solid 2px"/> </p>
+
+### Extra 'mini.nvim' functionality
+
+See more details in [Features](#features) and [Documentation](../doc/mini-extra.txt).
+
+---
+
+> [!NOTE]
+> This was previously hosted at a personal `echasnovski` GitHub account. 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).
+
+⦿ This is a part of [mini.nvim](https://nvim-mini.org/mini.nvim) library. Please use [this link](https://nvim-mini.org/mini.nvim/readmes/mini-extra) if you want to mention this module.
+
+⦿ All contributions (issues, pull requests, discussions, etc.) are done inside of 'mini.nvim'.
+
+⦿ See [whole library documentation](https://nvim-mini.org/mini.nvim/doc/mini-nvim) to learn about general design principles, disable/configuration recipes, and more.
+
+⦿ See [MiniMax](https://nvim-mini.org/MiniMax) for a full config example that uses this module.
+
+---
+
+If you want to help this project grow but don't know where to start, check out [contributing guides of 'mini.nvim'](https://nvim-mini.org/mini.nvim/CONTRIBUTING) or leave a Github star for 'mini.nvim' project and/or any its standalone Git repositories.
+
+## Demo
+
+<!-- Demo source: https://github.com/nvim-mini/assets/blob/main/demo/demo-extra.mp4 -->
+https://github.com/nvim-mini/mini.nvim/assets/24854248/31ceb716-eefa-4858-b77f-5b6b3fe594f5
+
+## Features
+
+Extra useful functionality which is not essential enough for other 'mini.nvim' modules to include directly.
+
+Features:
+
+- Various pickers for ['mini.pick'](https://nvim-mini.org/mini.nvim/readmes/mini-pick):
+    - Built-in diagnostic (`MiniExtra.pickers.diagnostic()`).
+    - File explorer (`MiniExtra.pickers.explorer()`).
+    - Git branches/commits/files/hunks (`MiniExtra.pickers.git_hunks()`, etc.).
+    - Command/search/input history (`MiniExtra.pickers.history()`).
+    - LSP references/symbols/etc. (`MiniExtra.pickers.lsp()`).
+    - Tree-sitter nodes (`MiniExtra.pickers.treesitter()`).
+    - **And much more**.
+  See `:h MiniExtra.pickers` for more.
+
+- Various textobject specifications for ['mini.ai'](https://nvim-mini.org/mini.nvim/readmes/mini-ai). See `:h MiniExtra.gen_ai_spec`.
+
+- Various highlighters for ['mini.hipatterns'](https://nvim-mini.org/mini.nvim/readmes/mini-hipatterns). See `:h MiniExtra.gen_highlighter`.
+
+Notes:
+
+- This module requires only those 'mini.nvim' modules which are needed for a particular functionality: 'mini.pick' for pickers, etc.
+
+For more information see these parts of help:
+
+- `:h MiniExtra.pickers`
+- `:h MiniExtra.gen_ai_spec`
+- `:h MiniExtra.gen_highlighter`
+
+## Installation
+
+This plugin can be installed as part of 'mini.nvim' library (**recommended**) or as a standalone Git repository.
+
+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 (use only one):
+
+<details>
+<summary><b>(Recommended)</b> With <a href="https://neovim.io/doc/user/helptag.html?tag=vim.pack">vim.pack</a> (on Neovim 0.12 and newer)</summary>
+
+**Full library**
+
+Follow ['mini.nvim' installation](https://nvim-mini.org/mini.nvim#installation).
+
+**Standalone plugin**
+
+Main branch:
+
+```lua
+vim.pack.add({ 'https://github.com/nvim-mini/mini.extra' })
+```
+
+Stable branch:
+
+```lua
+vim.pack.add({
+  { src = 'https://github.com/nvim-mini/mini.extra', version = 'stable' },
+})
+```
+
+</details>
+
+<details>
+<summary>With <a href="https://nvim-mini.org/mini.nvim/readmes/mini-deps">mini.deps</a> (before Neovim 0.12)</summary>
+
+**Full library**
+
+Follow [recommended 'mini.deps' installation](https://nvim-mini.org/mini.nvim/readmes/mini-deps#installation).
+
+**Standalone plugin**:
+
+Main branch:
+
+```lua
+add('nvim-mini/mini.extra')
+```
+
+Stable branch:
+
+```lua
+add({ source = 'nvim-mini/mini.extra', checkout = 'stable' })
+```
+
+</details>
+
+<details>
+<summary>With <a href="https://github.com/folke/lazy.nvim">folke/lazy.nvim</a></summary>
+
+**Full library**
+
+Follow ['mini.nvim' installation](https://nvim-mini.org/mini.nvim#installation).
+
+**Standalone plugin**
+
+Main branch:
+
+```lua
+{ 'nvim-mini/mini.extra', version = false },
+```
+
+Stable branch:
+
+```lua
+{ 'nvim-mini/mini.extra', version = '*' },
+```
+
+</details>
+
+**Important**: don't forget to call `require('mini.extra').setup()` to enable its functionality.
+
+**Note**: if you are on Windows, there might be problems with too long file paths (like `error: unable to create file <some file name>: Filename too long`). Try doing one of the following:
+
+- Enable corresponding git global config value: `git config --system core.longpaths true`. Then try to reinstall.
+- Install plugin in other place with shorter path.
+
+## Default config
+
+```lua
+-- No need to copy this inside `setup()`. Will be used automatically.
+{}
+```
+
+## Similar plugins
+
+- [nvim-telescope/telescope.nvim](https://github.com/nvim-telescope/telescope.nvim)
+- [ibhagwan/fzf-lua](https://github.com/ibhagwan/fzf-lua)