retrovim 0.0.3

package/nvim/plugins/mini.nvim/doc/mini-base16.txt

@@ -0,0 +1,285 @@
+*mini.base16* Base16 colorscheme creation
+
+MIT License Copyright (c) 2021 Evgeni Chasnovski
+
+------------------------------------------------------------------------------
+                                                                    *MiniBase16*
+Fast implementation of [chriskempson/base16](https://github.com/chriskempson/base16)
+color scheme (with Copyright (C) 2012 Chris Kempson) adapted for modern Neovim
+Lua plugins. Extra features:
+- Configurable automatic support of cterm colors (see |highlight-cterm|).
+- Opinionated palette generator based only on background and foreground
+  colors.
+
+Supported highlight groups:
+- Built-in Neovim LSP and diagnostic.
+
+- Plugins (either with explicit definition or by verification that default
+  highlighting works appropriately):
+    - [nvim-mini/mini.nvim](https://nvim-mini.org/mini.nvim)
+    - [akinsho/bufferline.nvim](https://github.com/akinsho/bufferline.nvim)
+    - [anuvyklack/hydra.nvim](https://github.com/anuvyklack/hydra.nvim)
+    - [DanilaMihailov/beacon.nvim](https://github.com/DanilaMihailov/beacon.nvim)
+    - [folke/lazy.nvim](https://github.com/folke/lazy.nvim)
+    - [folke/noice.nvim](https://github.com/folke/noice.nvim)
+    - [folke/snacks.nvim](https://github.com/folke/snacks.nvim)
+    - [folke/todo-comments.nvim](https://github.com/folke/todo-comments.nvim)
+    - [folke/trouble.nvim](https://github.com/folke/trouble.nvim)
+    - [folke/which-key.nvim](https://github.com/folke/which-key.nvim)
+    - [ggandor/leap.nvim](https://github.com/ggandor/leap.nvim)
+    - [ggandor/lightspeed.nvim](https://github.com/ggandor/lightspeed.nvim)
+    - [glepnir/dashboard-nvim](https://github.com/glepnir/dashboard-nvim)
+    - [glepnir/lspsaga.nvim](https://github.com/glepnir/lspsaga.nvim)
+    - [HiPhish/rainbow-delimiters.nvim](https://github.com/HiPhish/rainbow-delimiters.nvim)
+    - [hrsh7th/nvim-cmp](https://github.com/hrsh7th/nvim-cmp)
+    - [justinmk/vim-sneak](https://github.com/justinmk/vim-sneak)
+    - [ibhagwan/fzf-lua](https://github.com/ibhagwan/fzf-lua)
+    - [kevinhwang91/nvim-bqf](https://github.com/kevinhwang91/nvim-bqf)
+    - [kevinhwang91/nvim-ufo](https://github.com/kevinhwang91/nvim-ufo)
+    - [lewis6991/gitsigns.nvim](https://github.com/lewis6991/gitsigns.nvim)
+    - [lukas-reineke/indent-blankline.nvim](https://github.com/lukas-reineke/indent-blankline.nvim)
+    - [MeanderingProgrammer/render-markdown.nvim](https://github.com/MeanderingProgrammer/render-markdown.nvim)
+    - [neoclide/coc.nvim](https://github.com/neoclide/coc.nvim)
+    - [NeogitOrg/neogit](https://github.com/NeogitOrg/neogit)
+    - [nvim-lualine/lualine.nvim](https://github.com/nvim-lualine/lualine.nvim)
+    - [nvim-neo-tree/neo-tree.nvim](https://github.com/nvim-neo-tree/neo-tree.nvim)
+    - [nvim-telescope/telescope.nvim](https://github.com/nvim-telescope/telescope.nvim)
+    - [nvim-tree/nvim-tree.lua](https://github.com/nvim-tree/nvim-tree.lua)
+    - [OXY2DEV/helpview.nvim](https://github.com/OXY2DEV/helpview.nvim)
+    - [OXY2DEV/markview.nvim](https://github.com/OXY2DEV/markview.nvim)
+    - [phaazon/hop.nvim](https://github.com/phaazon/hop.nvim)
+    - [rcarriga/nvim-dap-ui](https://github.com/rcarriga/nvim-dap-ui)
+    - [rcarriga/nvim-notify](https://github.com/rcarriga/nvim-notify)
+    - [rlane/pounce.nvim](https://github.com/rlane/pounce.nvim)
+    - [romgrk/barbar.nvim](https://github.com/romgrk/barbar.nvim)
+    - [saghen/blink.cmp](https://github.com/saghen/blink.cmp)
+    - [stevearc/aerial.nvim](https://github.com/stevearc/aerial.nvim)
+    - [williamboman/mason.nvim](https://github.com/williamboman/mason.nvim)
+
+# Setup ~
+
+This module needs a setup with `require('mini.base16').setup({})` (replace
+`{}` with your `config` table). It will create global Lua table
+`MiniBase16` which you can use for scripting or manually (with
+`:lua MiniBase16.*`).
+
+See |MiniBase16.config| for `config` structure and default values.
+
+This module doesn't have runtime options, so using `vim.b.minibase16_config`
+will have no effect here.
+
+Example: >lua
+
+  require('mini.base16').setup({
+    palette = {
+      base00 = '#112641',
+      base01 = '#3a475e',
+      base02 = '#606b81',
+      base03 = '#8691a7',
+      base04 = '#d5dc81',
+      base05 = '#e2e98f',
+      base06 = '#eff69c',
+      base07 = '#fcffaa',
+      base08 = '#ffcfa0',
+      base09 = '#cc7e46',
+      base0A = '#46a436',
+      base0B = '#9ff895',
+      base0C = '#ca6ecf',
+      base0D = '#42f7ff',
+      base0E = '#ffc4ff',
+      base0F = '#00a5c5',
+    },
+    use_cterm = true,
+    plugins = {
+      default = false,
+      ['nvim-mini/mini.nvim'] = true,
+    },
+  })
+<
+# Notes ~
+
+1. This is used to create some of plugin's color schemes
+   (see |MiniBase16-color-schemes|).
+2. Using `setup()` doesn't actually create a |:colorscheme|. It basically
+   creates a coordinated set of |highlight-groups|. To create your own theme:
+    - Put "myscheme.lua" file (name after your chosen theme name) inside
+      any "colors" directory reachable from |'runtimepath'| ("colors" inside
+      your Neovim config directory is usually enough).
+    - Inside "myscheme.lua" call `require('mini.base16').setup()` with your
+      palette and only after that set |g:colors_name| to "myscheme".
+
+------------------------------------------------------------------------------
+                                                      *MiniBase16-color-schemes*
+# Base16 colorschemes ~
+
+This module comes with several pre-built color schemes. Each of them is
+a |mini.base16| theme created with faster version of the following Lua code: >lua
+
+  require('mini.base16').setup({ palette = palette, use_cterm = true })
+<
+Activate them as regular |:colorscheme| (for example, `:colorscheme minischeme`).
+
+## minischeme ~
+*minischeme*
+
+Blue and yellow main colors with high contrast and saturation palette.
+Palettes are: >lua
+
+  -- For dark 'background':
+  MiniBase16.mini_palette('#112641', '#e2e98f', 75)
+
+  -- For light 'background':
+  MiniBase16.mini_palette('#e2e5ca', '#002a83', 75)
+<
+## minicyan ~
+*minicyan*
+
+Cyan and grey main colors with moderate contrast and saturation palette.
+Palettes are: >lua
+
+  -- For dark 'background':
+  MiniBase16.mini_palette('#0A2A2A', '#D0D0D0', 50)
+
+  -- For light 'background':
+  MiniBase16.mini_palette('#C0D2D2', '#262626', 80)
+<
+------------------------------------------------------------------------------
+                                                            *MiniBase16.setup()*
+                          `MiniBase16.setup`({config})
+Module setup
+
+Setup is done by applying base16 palette to enable colorscheme. Highlight
+groups make an extended set from original
+[base16-vim](https://github.com/chriskempson/base16-vim/) plugin. It is a
+good idea to have `config.palette` respect the original [styling
+principles](https://github.com/chriskempson/base16/blob/master/styling.md).
+
+By default only "gui highlighting" (see |highlight-gui| and
+|'termguicolors'|) is supported. To support "cterm highlighting" (see
+|highlight-cterm|) supply `config.use_cterm` argument in one of the formats:
+- `true` to auto-generate from `palette` (as closest colors).
+- Table with similar structure to `palette` but having terminal colors
+  (integers from 0 to 255) instead of hex strings.
+
+Parameters ~
+{config} `(table)` Module config table. See |MiniBase16.config|.
+
+Usage ~
+>lua
+  require('mini.base16').setup({}) -- replace {} with your config table
+                                   -- needs `palette` field present
+<
+------------------------------------------------------------------------------
+                                                             *MiniBase16.config*
+                              `MiniBase16.config`
+Defaults ~
+>lua
+  MiniBase16.config = {
+    -- Table with names from `base00` to `base0F` and values being strings of
+    -- HEX colors with format "#RRGGBB". NOTE: this should be explicitly
+    -- supplied in `setup()`.
+    palette = nil,
+
+    -- Whether to support cterm colors. Can be boolean, `nil` (same as
+    -- `false`), or table with cterm colors. See `setup()` documentation for
+    -- more information.
+    use_cterm = nil,
+
+    -- Plugin integrations. Use `default = false` to disable all integrations.
+    -- Also can be set per plugin (see |MiniBase16.config|).
+    plugins = { default = true },
+  }
+<
+# Plugin integrations ~
+
+`config.plugins` defines for which supported plugins highlight groups will
+be created. Limiting number of integrations slightly decreases startup time.
+It is a table with boolean (`true`/`false`) values which are applied as follows:
+- If plugin name (as listed in |mini.base16|) has entry, it is used.
+- Otherwise `config.plugins.default` is used.
+
+Example which will load only "mini.nvim" integration: >lua
+
+  require('mini.base16').setup({
+    palette = require('mini.base16').mini_palette('#112641', '#e2e98f', 75),
+    plugins = {
+      default = false,
+      ['nvim-mini/mini.nvim'] = true,
+    }
+  })
+<
+------------------------------------------------------------------------------
+                                                     *MiniBase16.mini_palette()*
+     `MiniBase16.mini_palette`({background}, {foreground}, {accent_chroma})
+Create MINI Base16 palette
+
+Create base16 palette based on the HEX (string `'#RRGGBB'`) colors of main
+background and foreground with optional setting of accent chroma (see
+details).
+
+# Algorithm design ~
+
+- Main operating color space is
+  [CIELCh(uv)](https://en.wikipedia.org/wiki/CIELUV#Cylindrical_representation_(CIELCh))
+  which is a cylindrical representation of a perceptually uniform CIELUV
+  color space. It defines color by three values: lightness L (values from 0
+  to 100), chroma (positive values), and hue (circular values from 0 to 360
+  degrees). Useful converting tool: https://www.easyrgb.com/en/convert.php
+- There are four important lightness values: background, foreground, focus
+  (around the middle of background and foreground, leaning towards
+  foreground), and edge (extreme lightness closest to foreground).
+- First four colors have the same chroma and hue as `background` but
+  lightness progresses from background towards focus.
+- Second four colors have the same chroma and hue as `foreground` but
+  lightness progresses from foreground towards edge in such a way that
+  `base05` color is main foreground color.
+- The rest eight colors are accent colors which are created in pairs
+    - Each pair has same hue from set of hues "most different" to
+      background and foreground hues (if respective chorma is positive).
+    - All colors have the same chroma equal to `accent_chroma` (if not
+      provided, chroma of foreground is used, as they will appear next
+      to each other). Note: this means that in case of low foreground
+      chroma, it is a good idea to set `accent_chroma` manually.
+      Values from 30 (low chorma) to 80 (high chroma) are common.
+    - Within pair there is base lightness (equal to foreground
+      lightness) and alternative (equal to focus lightness). Base
+      lightness goes to colors which will be used more frequently in
+      code: base08 (variables), base0B (strings), base0D (functions),
+      base0E (keywords).
+  How exactly accent colors are mapped to base16 palette is a result of
+  trial and error. One rule of thumb was: colors within one hue pair should
+  be more often seen next to each other. This is because it is easier to
+  distinguish them and seems to be more visually appealing. That is why
+  `base0D` and `base0F` have same hues because they usually represent
+  functions and delimiter (brackets included).
+
+Parameters ~
+{background} `(string)` Background HEX color (formatted as `#RRGGBB`).
+{foreground} `(string)` Foreground HEX color (formatted as `#RRGGBB`).
+{accent_chroma} `(number)` Optional positive number (usually between 0
+  and 100). Default: chroma of foreground color.
+
+Return ~
+`(table)` Table with base16 palette.
+
+Usage ~
+>lua
+  local p = require('mini.base16').mini_palette('#112641', '#e2e98f', 75)
+  require('mini.base16').setup({ palette = p })
+<
+------------------------------------------------------------------------------
+                                     *MiniBase16.rgb_palette_to_cterm_palette()*
+              `MiniBase16.rgb_palette_to_cterm_palette`({palette})
+Converts palette with RGB colors to terminal colors
+
+Useful for caching `use_cterm` variable to increase speed.
+
+Parameters ~
+{palette} `(table)` Table with base16 palette (same as in
+  `MiniBase16.config.palette`).
+
+Return ~
+`(table)` Table with base16 palette using |highlight-cterm|.
+
+
+ vim:tw=78:ts=8:noet:ft=help:norl:

package/nvim/plugins/mini.nvim/doc/mini-basics.txt

@@ -0,0 +1,359 @@
+*mini.basics* Common configuration presets
+
+MIT License Copyright (c) 2023 Evgeni Chasnovski
+
+------------------------------------------------------------------------------
+                                                                    *MiniBasics*
+Install, create `init.lua`, add `require('mini.basics').setup()`, and you
+are good to go.
+
+Features:
+- Presets for common options. It will only change option if it wasn't
+  manually set before. See more in |MiniBasics.config.options|.
+
+- Presets for common mappings. It will only add a mapping if it wasn't
+  manually created before. See more in |MiniBasics.config.mappings|.
+
+- Presets for common autocommands. See more in |MiniBasics.config.autocommands|.
+
+- Reverse compatibility is a high priority. Any decision to change already
+  present behavior will be made with great care.
+
+Notes:
+- Main goal of this module is to provide a relatively easier way for
+  new-ish Neovim users to have better "works out of the box" experience
+  while having documented relevant options/mappings/autocommands to study.
+  It is based partially on survey among Neovim users and partially is
+  coming from personal preferences.
+
+  However, more seasoned users almost surely will find something useful.
+
+  Still, it is recommended to read about used options/mappings/autocommands
+  and decide if they are needed. The main way to do that is by reading
+  Neovim's help pages (linked in help file) and this module's source code
+  (thoroughly documented for easier comprehension).
+
+# Setup ~
+
+This module needs a setup with `require('mini.basics').setup({})` (replace
+`{}` with your `config` table). It will create global Lua table `MiniBasics`
+which you can use for scripting or manually (with `:lua MiniBasics.*`).
+
+See |MiniBasics.config| for available config settings.
+
+To stop module from showing non-error feedback, set `config.silent = true`.
+
+# Comparisons ~
+
+- [tpope/vim-sensible](https://github.com/tpope/vim-sensible):
+    - Most of `tpope/vim-sensible` is already incorporated as default
+      options in Neovim (see |nvim-defaults|). This module has a much
+      broader effect.
+- [tpope/vim-unimpaired](https://github.com/tpope/vim-unimpaired):
+    - The `tpope/vim-unimpaired` has mapping for toggling options with `yo`
+      prefix. This module implements similar functionality with `\` prefix
+      (see |MiniBasics.config.mappings|).
+
+------------------------------------------------------------------------------
+                                                            *MiniBasics.setup()*
+                          `MiniBasics.setup`({config})
+Module setup
+
+Parameters ~
+{config} `(table|nil)` Module config table. See |MiniBasics.config|.
+
+Usage ~
+>lua
+  require('mini.basics').setup() -- use default config
+  -- OR
+  require('mini.basics').setup({}) -- replace {} with your config table
+<
+------------------------------------------------------------------------------
+                                                             *MiniBasics.config*
+                              `MiniBasics.config`
+Defaults ~
+>lua
+  MiniBasics.config = {
+    -- Options. Set field to `false` to disable.
+    options = {
+      -- Basic options ('number', 'ignorecase', and many more)
+      basic = true,
+
+      -- Extra UI features ('winblend', 'listchars', 'pumheight', ...)
+      extra_ui = false,
+
+      -- Presets for window borders ('single', 'double', ...)
+      -- Default 'auto' infers from 'winborder' option
+      win_borders = 'auto',
+    },
+
+    -- Mappings. Set field to `false` to disable.
+    mappings = {
+      -- Basic mappings (better 'jk', save with Ctrl+S, ...)
+      basic = true,
+
+      -- Prefix for mappings that toggle common options ('wrap', 'spell', ...).
+      -- Supply empty string to not create these mappings.
+      option_toggle_prefix = [[\]],
+
+      -- Window navigation with <C-hjkl>, resize with <C-arrow>
+      windows = false,
+
+      -- Move cursor in Insert, Command, and Terminal mode with <M-hjkl>
+      move_with_alt = false,
+    },
+
+    -- Autocommands. Set field to `false` to disable
+    autocommands = {
+      -- Basic autocommands (highlight on yank, start Insert in terminal, ...)
+      basic = true,
+
+      -- Set 'relativenumber' only in linewise and blockwise Visual mode
+      relnum_in_visual_mode = false,
+    },
+
+    -- Whether to disable showing non-error feedback
+    silent = false,
+  }
+<
+# Options ~
+*MiniBasics.config.options*
+
+Usage example: >lua
+
+  require('mini.basics').setup({
+    options = {
+      basic = true,
+      extra_ui = true,
+      win_borders = 'double',
+    }
+  })
+<
+## options.basic ~
+
+The `config.options.basic` sets certain options to values which are quite
+commonly used (judging by study of available Neovim pre-configurations,
+public dotfiles, and surveys).
+Any option is changed only if it was not set manually beforehand.
+For exact changes, please see source code (`lua/mini/basics.lua`).
+
+Here is the list of affected options (put cursor on it and press |CTRL-]|):
+- General:
+    - Sets |<Leader>| key to |<Space>|. Be sure to make all Leader mappings
+      after this (otherwise they are made with default <Leader>).
+    - Runs `:filetype plugin indent on` (see |:filetype-overview|)
+    - |'backup'|
+    - |'mouse'|
+    - |'undofile'|
+    - |'writebackup'|
+- Appearance
+    - |'breakindent'|
+    - |'cursorline'|
+    - |'fillchars'|
+    - |'linebreak'|
+    - |'number'|
+    - |'ruler'|
+    - |'showmode'|
+    - |'signcolumn'|
+    - |'shortmess'|
+    - |'splitbelow'|
+    - |'splitkeep'|
+    - |'splitright'|
+    - |'termguicolors'| (on Neovim<0.10; later versions have it smartly enabled)
+    - |'wrap'|
+- Editing
+    - |'completeopt'|
+    - |'formatoptions'|
+    - |'ignorecase'|
+    - |'incsearch'|
+    - |'infercase'|
+    - |'smartcase'|
+    - |'smartindent'|
+    - |'virtualedit'|
+
+## options.extra_ui ~
+
+The `config.options.extra_ui` sets certain options for visual appearance
+which might not be aligned with common preferences, but still worth trying.
+Any option is changed only if it was not set manually beforehand.
+For exact changes, please see source code (`lua/mini/basics.lua`).
+
+List of affected options:
+- |'list'|
+- |'listchars'|
+- |'pumblend'|
+- |'pumheight'|
+- |'winblend'|
+- Runs `:syntax on` (see |:syntax-on|)
+
+## options.win_borders ~
+
+The `config.options.win_borders` updates |'fillchars'| to have a consistent set
+of characters for window border (`vert`, `horiz`, `msgsep`, etc.).
+
+Available values:
+- `'auto'` - infer from |'winborder'|. On Neovim<0.11 do nothing.
+- `'bold'` - bold lines.
+- `'dot'` - dot in every cell.
+- `'double'` - double line.
+- `'single'` - single line.
+- `'solid'` - no symbol, only background.
+
+# Mappings ~
+*MiniBasics.config.mappings*
+
+Usage example: >lua
+
+  require('mini.basics').setup({
+    mappings = {
+      basic = true,
+      option_toggle_prefix = [[\]],
+      windows = true,
+      move_with_alt = true,
+    }
+  })
+<
+If you want some mappings to be different or not made at all, set or delete
+them after calling |MiniBasics.setup()|.
+
+## mappings.basic ~
+
+The `config.mappings.basic` creates mappings for certain commonly mapped actions
+(judging by study of available Neovim pre-configurations and public dotfiles).
+
+Some of the mappings override built-in ones to either improve their
+behavior or override its default not very useful action.
+It will only add a mapping if it wasn't manually created before.
+
+Here is a table with created mappings : >
+
+ |Keys   |     Modes       |                  Description                  |
+ |-------|-----------------|-----------------------------------------------|
+ | j     | Normal, Visual  | Move down by visible lines with no [count]    |
+ | k     | Normal, Visual  | Move up by visible lines with no [count]      |
+ | go    | Normal          | Add [count] empty lines after cursor          |
+ | gO    | Normal          | Add [count] empty lines before cursor         |
+ | gy    | Normal, Visual  | Copy to system clipboard                      |
+ | gp    | Normal, Visual  | Paste from system clipboard                   |
+ | gV    | Normal          | Visually select latest changed or yanked text |
+ | g/    | Visual          | Search inside current visual selection        |
+ | *     | Visual          | Search forward for current visual selection   |
+ | #     | Visual          | Search backward for current visual selection  |
+ | <C-s> | Normal, Visual, | Save and go to Normal mode                    |
+ |       |     Insert      |                                               |
+<
+Notes:
+- See |[count]| for its meaning.
+- On Neovim>=0.10 mappings for `#` and `*` are not created as their
+  enhanced variants are made built-in. See |v_star-default| and |v_#-default|.
+- On Neovim>=0.11 there are |[<Space>| / |]<Space>| for adding empty lines.
+  The `gO` and `go` mappings are still created as they are more aligned with
+  similarly purposed |O| and |o| keys (although sometimes conflict with |gO|).
+
+## mappings.option_toggle_prefix ~
+
+The `config.mappings.option_toggle_prefix` defines a prefix used for
+creating mappings that toggle common options. The result mappings will be
+`<prefix> + <suffix>`. For example, with default value, `\w` will toggle |'wrap'|.
+
+Other viable choices for prefix are
+- `,` (as a mnemonic for several values to toggle).
+- `|` (as a same mnemonic).
+- `yo` (used in `tpope/vim-unimpaired`)
+- Something with |<Leader>| key, like `<Leader>t` (`t` for "toggle"). Note:
+  if your prefix contains `<Leader>` key, make sure to set it before
+  calling |MiniBasics.setup()| (as is done with default `basic` field of
+  |MiniBasics.config.options|).
+
+After toggling, there will be a feedback about the current option value if
+prior to `require('mini.basics').setup()` module wasn't silenced (see
+"Silencing" section in |mini.basics|).
+
+It will only add a mapping if it wasn't manually created before.
+
+Here is a list of suffixes for created toggling mappings (all in Normal mode):
+
+- `b` - |'background'|.
+- `c` - |'cursorline'|.
+- `C` - |'cursorcolumn'|.
+- `d` - diagnostic (via |vim.diagnostic| functions).
+- `h` - |'hlsearch'| (or |v:hlsearch| to be precise).
+- `i` - |'ignorecase'|.
+- `l` - |'list'|.
+- `n` - |'number'|.
+- `r` - |'relativenumber'|.
+- `s` - |'spell'|.
+- `w` - |'wrap'|.
+
+## mappings.windows ~
+
+The `config.mappings.windows` creates mappings for easiere window manipulation.
+
+It will only add a mapping if it wasn't manually created before.
+
+Here is a list with created Normal mode mappings (all respect |[count]|):
+- Window navigation:
+    - `<C-h>` - focus on left window (see |CTRL-W_H|).
+    - `<C-j>` - focus on below window (see |CTRL-W_J|).
+    - `<C-k>` - focus on above window (see |CTRL-W_K|).
+    - `<C-l>` - focus on right window (see |CTRL-W_L|).
+- Window resize (all use arrow keys; variants of |:resize|; respect |[count]|):
+    - `<C-left>`  - decrease window width.
+    - `<C-down>`  - decrease window height.
+    - `<C-up>`    - increase window height.
+    - `<C-right>` - increase window width.
+
+## mappings.move_with_alt ~
+
+The `config.mappings.move_with_alt` creates mappings for a more consistent
+cursor move in Insert, Command, and Terminal modes. For example, it proves
+useful in combination of autopair plugin (like |mini.pairs|) to move right
+outside of inserted pairs (no matter what the pair is).
+
+It will only add a mapping if it wasn't manually created before.
+
+Here is a list of created mappings (`<M-x>` means `Alt`/`Meta` plus `x`):
+- `<M-h>` - move cursor left.  Modes: Insert, Terminal, Command.
+- `<M-j>` - move cursor down.  Modes: Insert, Terminal.
+- `<M-k>` - move cursor up.    Modes: Insert, Terminal.
+- `<M-l>` - move cursor right. Modes: Insert, Terminal, Command.
+
+# Autocommands ~
+*MiniBasics.config.autocommands*
+
+Usage example: >lua
+
+  require('mini.basics').setup({
+    autocommands = {
+      basic = true,
+      relnum_in_visual_mode = true,
+    }
+  })
+<
+## autocommands.basic ~
+
+The `config.autocommands.basic` creates some common autocommands:
+
+- Starts insert mode when opening terminal (see |:startinsert| and |TermOpen|).
+- Highlights yanked text for a brief period of time. See |vim.hl.on_yank()|
+  (which is |vim.hl.hl_op()| on Neovim>=0.13 and |vim.highlight.on_yank()|
+  on Neovim<0.11) and |TextYankPost|.
+
+## autocommands.relnum_in_visual_mode ~
+
+The `config.autocommands.relnum_in_visual_mode` creates autocommands that
+enable |'relativenumber'| in linewise and blockwise Visual modes and disable
+otherwise. See |ModeChanged|.
+
+------------------------------------------------------------------------------
+                                                *MiniBasics.toggle_diagnostic()*
+                        `MiniBasics.toggle_diagnostic`()
+Toggle diagnostic for current buffer
+
+This uses |vim.diagnostic| functions per buffer.
+
+Return ~
+`(string)` String indicator for new state. Similar to what |:set| `{option}?` shows.
+
+
+ vim:tw=78:ts=8:noet:ft=help:norl: