christoph/flake-nixinator
1
Fork 0
Code Activity

Update generated neovim config

Browse Source
This commit is contained in:
Christoph Urlacher
2024-08-15 14:28:54 +02:00
parent 07409c223d
commit 25cfcf2941
3809 changed files with 351157 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

185
config/neovim/store/lazy-plugins/mini.nvim/readmes/mini-starter.md Normal file
View File

@ -0,0 +1,185 @@
<img src="https://github.com/echasnovski/media/blob/main/mini.nvim/logo/logo_starter.png" style="width: 100%"/>
<!-- badges: start -->
[![GitHub license](https://badgen.net/github/license/echasnovski/mini.nvim)](https://github.com/echasnovski/mini.nvim/blob/main/LICENSE)
<!-- badges: end -->
### Fast and flexible start screen
See more details in [Features](#features) and [help file](../doc/mini-starter.txt).
---
⦿ This is a part of [mini.nvim](https://github.com/echasnovski/mini.nvim) library. Please use [this link](https://github.com/echasnovski/mini.nvim/blob/main/readmes/mini-starter.md) if you want to mention this module.
⦿ All contributions (issues, pull requests, discussions, etc.) are done inside of 'mini.nvim'.
⦿ See the repository page to learn about common design principles and configuration recipes.
---
If you want to help this project grow but don't know where to start, check out [contributing guides of 'mini.nvim'](https://github.com/echasnovski/mini.nvim/blob/main/CONTRIBUTING.md) or leave a Github star for 'mini.nvim' project and/or any its standalone Git repositories.
## Demo
https://user-images.githubusercontent.com/24854248/173045153-19087983-0211-4ab9-8278-909616b53c7e.mp4
## Features
- All available actions are defined inside items. There are pre-configured whole sections in `MiniStarter.sections`.
- Configure what items are displayed by supplying an array which can be normalized to an array of items. Read about how supplied items are normalized in `MiniStarter.refresh()`.
- Modify the final look by supplying content hooks. There are pre-configured content hook generators in `MiniStarter.gen_hook`.
- Choosing an item can be done in two ways:
- Type prefix query to filter item by matching its name (ignoring case). Displayed information is updated after every typed character. For every item its unique prefix is highlighted.
- Use Down/Up arrows (or `<C-n>`/`<C-p>`, or `<M-j>`/`<M-k>`) and hit Enter.
- Allow multiple simultaneously open Starter buffers.
## 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>With <a href="https://github.com/echasnovski/mini.nvim/blob/main/readmes/mini-deps.md">mini.deps</a></summary>
<table>
<thead>
<tr>
<th>Github repo</th>
<th>Branch</th> <th>Code snippet</th>
</tr>
</thead>
<tbody>
<tr>
<td rowspan=2>'mini.nvim' library</td> <td>Main</td> <td rowspan=2><i>Follow recommended 'mini.deps' installation</i></td>
</tr>
<tr>
<td>Stable</td>
</tr>
<tr>
<td rowspan=2>Standalone plugin</td> <td>Main</td> <td><code>add('echasnovski/mini.starter')</code></td>
</tr>
<tr>
<td>Stable</td> <td><code>add({ source = 'echasnovski/mini.starter', checkout = 'stable' })</code></td>
</tr>
</tbody>
</table>
</details>
<details>
<summary>With <a href="https://github.com/folke/lazy.nvim">folke/lazy.nvim</a></summary>
<table>
<thead>
<tr>
<th>Github repo</th>
<th>Branch</th> <th>Code snippet</th>
</tr>
</thead>
<tbody>
<tr>
<td rowspan=2>'mini.nvim' library</td>
<td>Main</td> <td><code>{ 'echasnovski/mini.nvim', version = false },</code></td>
</tr>
<tr>
<td>Stable</td> <td><code>{ 'echasnovski/mini.nvim', version = '*' },</code></td>
</tr>
<tr>
<td rowspan=2>Standalone plugin</td>
<td>Main</td> <td><code>{ 'echasnovski/mini.starter', version = false },</code></td>
</tr>
<tr>
<td>Stable</td> <td><code>{ 'echasnovski/mini.starter', version = '*' },</code></td>
</tr>
</tbody>
</table>
</details>
<details>
<summary>With <a href="https://github.com/junegunn/vim-plug">junegunn/vim-plug</a></summary>
<table>
<thead>
<tr>
<th>Github repo</th>
<th>Branch</th> <th>Code snippet</th>
</tr>
</thead>
<tbody>
<tr>
<td rowspan=2>'mini.nvim' library</td>
<td>Main</td> <td><code>Plug 'echasnovski/mini.nvim'</code></td>
</tr>
<tr>
<td>Stable</td> <td><code>Plug 'echasnovski/mini.nvim', { 'branch': 'stable' }</code></td>
</tr>
<tr>
<td rowspan=2>Standalone plugin</td> <td>Main</td> <td><code>Plug 'echasnovski/mini.starter'</code></td>
</tr>
<tr>
<td>Stable</td> <td><code>Plug 'echasnovski/mini.starter', { 'branch': 'stable' }</code></td>
</tr>
</tbody>
</table>
</details>
<br>
**Important**: don't forget to call `require('mini.starter').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.
{
-- Whether to open starter buffer on VimEnter. Not opened if Neovim was
-- started with intent to show something else.
autoopen = true,
-- Whether to evaluate action of single active item
evaluate_single = false,
-- Items to be displayed. Should be an array with the following elements:
-- - Item: table with <action>, <name>, and <section> keys.
-- - Function: should return one of these three categories.
-- - Array: elements of these three types (i.e. item, array, function).
-- If `nil` (default), default items will be used (see |mini.starter|).
items = nil,
-- Header to be displayed before items. Converted to single string via
-- `tostring` (use `\n` to display several lines). If function, it is
-- evaluated first. If `nil` (default), polite greeting will be used.
header = nil,
-- Footer to be displayed after items. Converted to single string via
-- `tostring` (use `\n` to display several lines). If function, it is
-- evaluated first. If `nil` (default), default usage help will be shown.
footer = nil,
-- Array of functions to be applied consecutively to initial content.
-- Each function should take and return content for 'Starter' buffer (see
-- |mini.starter| and |MiniStarter.content| for more details).
content_hooks = nil,
-- Characters to update query. Each character will have special buffer
-- mapping overriding your global ones. Be careful to not add `:` as it
-- allows you to go into command mode.
query_updaters = 'abcdefghijklmnopqrstuvwxyz0123456789_-.',
-- Whether to disable showing non-error feedback
silent = false,
}
```
## Similar plugins
- [mhinz/vim-startify](https://github.com/mhinz/vim-startify)
- [glepnir/dashboard-nvim](https://github.com/glepnir/dashboard-nvim)
- [goolord/alpha-nvim](https://github.com/goolord/alpha-nvim)