Skip to content

Commit 992d3af

Browse files
committed
docs(ALL): tweak help files for better portability
Details: - Rename 'mini.txt' into 'mini-nvim.txt', as MINI is a separate name. - Make more friendly for the future "convert to markdown" script: - Don't use "#" prefix in inner "Title ~". - Use list in `---@seealso`. Otherwise many lines are parsed as one. - Make sure to always explicitly close code block. Otherwise content will not be parsed properly. - Use exact tag when linking (like |:colorscheme| and not |colorscheme|). Otherwise links to neovim.io documentation won't work. - Extract first lines (needed for working `:h local-additions` and showing license) into a separate comment block. Use alternative CamelCase module tag in next comment block with module overview. This makes final rendered markdown look better while extra right aligned tag adds an entry in table of contents.
1 parent 679dd50 commit 992d3af

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

88 files changed

+350
-515
lines changed

doc/mini-ai.txt

Lines changed: 23 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
*mini.ai* Extend and create a/i textobjects
2-
*MiniAi*
32

43
MIT License Copyright (c) 2022 Evgeni Chasnovski
54

6-
==============================================================================
7-
5+
------------------------------------------------------------------------------
6+
*MiniAi*
87
Enhance some builtin |text-objects| (like |a(|, |a)|, |a'|, and more),
98
create new ones (like `a*`, `a<Space>`, `af`, `a?`, and more), and allow
109
user to create their own.
@@ -61,7 +60,7 @@ What it doesn't (and probably won't) do:
6160
in 'targets.vim'). Whitespace handling is assumed to be done inside
6261
textobject specification (like `i(` and `i)` handle whitespace differently).
6362

64-
# Setup ~
63+
Setup ~
6564

6665
This module needs a setup with `require('mini.ai').setup({})` (replace
6766
`{}` with your `config` table). It will create global Lua table `MiniAi`
@@ -75,7 +74,7 @@ as `MiniAi.config`. See |mini.nvim-buffer-local-config| for more details.
7574

7675
To stop module from showing non-error feedback, set `config.silent = true`.
7776

78-
# Comparisons ~
77+
Comparisons ~
7978

8079
- 'wellle/targets.vim':
8180
- Has limited support for creating own textobjects: it is constrained
@@ -104,7 +103,7 @@ To stop module from showing non-error feedback, set `config.silent = true`.
104103
- Doesn't support multiple search method (basically, only 'cover').
105104
- Doesn't support consecutive application of target textobject.
106105

107-
# Disabling ~
106+
Disabling ~
108107

109108
To disable, set `vim.g.miniai_disable` (globally) or `vim.b.miniai_disable`
110109
(for a buffer) to `true`. Considering high number of different scenarios
@@ -230,22 +229,22 @@ Notes:
230229
Examples:
231230
1. Either balanced `()` or balanced `[]` but both with inner edge space: >lua
232231

233-
-- Composed pattern
234-
{ { '%b()', '%b[]' }, '^. .* .$' }
232+
-- Composed pattern
233+
{ { '%b()', '%b[]' }, '^. .* .$' }
235234

236-
-- Composed pattern expanded into equivalent array of nested patterns
237-
{ '%b()', '^. .* .$' } -- and
238-
{ '%b[]', '^. .* .$' }
235+
-- Composed pattern expanded into equivalent array of nested patterns
236+
{ '%b()', '^. .* .$' } -- and
237+
{ '%b[]', '^. .* .$' }
239238
<
240239
2. Either "balanced `()` with inner edge space" or "balanced `[]` with
241240
no inner edge space", both with 5 or more characters: >lua
242241

243-
-- Composed pattern
244-
{ { { '%b()', '^. .* .$' }, { '%b[]', '^.[^ ].*[^ ].$' } }, '.....' }
242+
-- Composed pattern
243+
{ { { '%b()', '^. .* .$' }, { '%b[]', '^.[^ ].*[^ ].$' } }, '.....' }
245244

246-
-- Composed pattern expanded into equivalent array of nested patterns
247-
{ '%b()', '^. .* .$', '.....' } -- and
248-
{ '%b[]', '^.[^ ].*[^ ].$', '.....' }
245+
-- Composed pattern expanded into equivalent array of nested patterns
246+
{ '%b()', '^. .* .$', '.....' } -- and
247+
{ '%b[]', '^.[^ ].*[^ ].$', '.....' }
249248
<
250249
- SPAN MATCHES COMPOSED PATTERN if it matches at least one nested pattern
251250
from expanded composed pattern.
@@ -461,9 +460,7 @@ Default values:
461460
silent = false,
462461
}
463462
<
464-
# Options ~
465-
466-
## Custom textobjects ~
463+
Custom textobjects ~
467464

468465
User can define own textobjects by supplying `config.custom_textobjects`.
469466
It should be a table with keys being single character textobject identifier
@@ -514,7 +511,7 @@ Examples:
514511
<
515512
There are more example specifications in |MiniAi-textobject-specification|.
516513

517-
## Search method ~
514+
Search method ~
518515

519516
Value of `config.search_method` defines how best match search is done.
520517
Based on its value, one of the following matches will be selected:
@@ -555,7 +552,7 @@ Here is an example of what `a)` textobject is based on a value of
555552
- `'prev'`: `(a) bbb (c)` -> `(a)`. Same outcome for `(bbb)`.
556553
- `'nearest'`: depends on cursor position (same as in `'cover_or_nearest'`).
557554

558-
## Mappings ~
555+
Mappings ~
559556

560557
Mappings `around_next` / `inside_next` and `around_last` / `inside_last` are
561558
essentially `around` / `inside` but using search method `'next'` and `'prev'`.
@@ -636,7 +633,7 @@ Example: >lua
636633
['|'] = gen_spec.pair('|', '|', { type = 'non-balanced' }),
637634
}
638635
})
639-
636+
<
640637
------------------------------------------------------------------------------
641638
*MiniAi.gen_spec.argument()*
642639
`MiniAi.gen_spec.argument`({opts})
@@ -685,7 +682,7 @@ Example:
685682
only alphanumeric or underscore (not dot).
686683

687684
Parameters ~
688-
{opts} `(table|nil)` Optsion. Allowed fields:
685+
{opts} `(table|nil)` Options. Allowed fields:
689686
- <name_pattern> - string pattern of character set allowed in function name.
690687
Default: `'[%w_%.]'` (alphanumeric, underscore, or dot).
691688
Note: should be enclosed in `[]`.
@@ -793,10 +790,10 @@ Return ~
793790
corresponding (`a` or `i`) treesitter capture.
794791

795792
See also ~
796-
|MiniAi-textobject-specification| for how this type of textobject
793+
- |MiniAi-textobject-specification| for how this type of textobject
797794
specification is processed.
798-
|vim.treesitter.get_query()| for how query is fetched.
799-
|Query:iter_captures()| for how all query captures are iterated in case of
795+
- |vim.treesitter.get_query()| for how query is fetched.
796+
- |Query:iter_captures()| for how all query captures are iterated in case of
800797
no 'nvim-treesitter'.
801798

802799
------------------------------------------------------------------------------

doc/mini-align.txt

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
*mini.align* Align text interactively
2-
*MiniAlign*
32

43
MIT License Copyright (c) 2022 Evgeni Chasnovski
54

6-
==============================================================================
7-
5+
------------------------------------------------------------------------------
6+
*MiniAlign*
87
Rich and flexible customization of both alignment rules and user interaction.
98
Works with charwise, linewise, and blockwise selections in both Normal mode
109
(on textobject/motion; with dot-repeat) and Visual mode.
@@ -40,7 +39,7 @@ Features:
4039
- Every user interaction is accompanied with helper status message showing
4140
relevant information about current alignment process.
4241

43-
# Setup ~
42+
Setup ~
4443

4544
This module needs a setup with `require('mini.align').setup({})` (replace
4645
`{}` with your `config` table). It will create global Lua table `MiniAlign`
@@ -54,7 +53,7 @@ as `MiniAlign.config`. See |mini.nvim-buffer-local-config| for more details.
5453

5554
To stop module from showing non-error feedback, set `config.silent = true`.
5655

57-
# Comparisons ~
56+
Comparisons ~
5857

5958
- 'junegunn/vim-easy-align':
6059
- 'mini.align' is mostly designed after 'junegunn/vim-easy-align', so
@@ -86,7 +85,7 @@ To stop module from showing non-error feedback, set `config.silent = true`.
8685
desirable. 'mini.align' does not by design: use Visual selection or
8786
textobject/motion to explicitly define region to align.
8887

89-
# Disabling ~
88+
Disabling ~
9089

9190
To disable, set `vim.g.minialign_disable` (globally) or `vim.b.minialign_disable`
9291
(for a buffer) to `true`. Considering high number of different scenarios
@@ -366,7 +365,7 @@ Special configurations for common splits ~
366365
After typing `<Space>`: >
367366
a b c
368367
aa bb cc
369-
368+
<
370369
------------------------------------------------------------------------------
371370
*MiniAlign-examples*
372371
More complex examples to explore functionality
@@ -493,9 +492,7 @@ Default values:
493492
silent = false,
494493
}
495494
<
496-
# Options ~
497-
498-
## Modifiers ~
495+
Modifiers ~
499496

500497
`MiniAlign.config.modifiers` is used to define interactive user experience
501498
of managing alignment process. It is a table with single character keys and
@@ -537,7 +534,7 @@ Examples:
537534
},
538535
})
539536
<
540-
## Options ~
537+
Options ~
541538

542539
`MiniAlign.config.options` defines default values of options used to control
543540
behavior of steps.
@@ -548,7 +545,7 @@ Examples:
548545
For more details about options see |MiniAlign.align_strings()| and entries of
549546
|MiniAlign.gen_step| for default main steps.
550547

551-
## Steps ~
548+
Steps ~
552549

553550
`MiniAlign.config.steps` defines default steps to be applied during
554551
alignment process.

doc/mini-animate.txt

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
*mini.animate* Animate common Neovim actions
2-
*MiniAnimate*
32

43
MIT License Copyright (c) 2022 Evgeni Chasnovski
54

6-
==============================================================================
7-
5+
------------------------------------------------------------------------------
6+
*MiniAnimate*
87
Features:
98
- Works out of the box with a single `require('mini.animate').setup()`.
109
No extra mappings or commands needed.
@@ -42,7 +41,7 @@ Notes:
4241
mappings, etc.). See |MiniAnimate.config.scroll| and
4342
|MiniAnimate.config.resize| for more details.
4443

45-
# Setup ~
44+
Setup ~
4645

4746
This module needs a setup with `require('mini.animate').setup({})` (replace
4847
`{}` with your `config` table). It will create global Lua table `MiniAnimate`
@@ -54,7 +53,7 @@ You can override runtime config settings (like `config.modifiers`) locally
5453
to buffer inside `vim.b.minianimate_config` which should have same structure
5554
as `MiniAnimate.config`. See |mini.nvim-buffer-local-config| for more details.
5655

57-
# Comparisons ~
56+
Comparisons ~
5857

5958
- Neovide:
6059
- Neovide is a standalone GUI which has more control over its animations.
@@ -79,15 +78,15 @@ as `MiniAnimate.config`. See |mini.nvim-buffer-local-config| for more details.
7978
while 'mini.animate' animates any resize with appropriate values of
8079
'winheight' / 'winwidth' and 'winminheight' / 'winminwidth').
8180

82-
# Highlight groups ~
81+
Highlight groups ~
8382

8483
* `MiniAnimateCursor` - highlight of cursor during its animated movement.
8584
* `MiniAnimateNormalFloat` - highlight of floating window for `open` and
8685
`close` animations.
8786

8887
To change any highlight group, modify it directly with |:highlight|.
8988

90-
# Disabling ~
89+
Disabling ~
9190

9291
To disable, set `vim.g.minianimate_disable` (globally) or
9392
`vim.b.minianimate_disable` (for a buffer) to `true`. Considering high
@@ -184,7 +183,7 @@ Default values:
184183
},
185184
}
186185
<
187-
# General ~
186+
General ~
188187
*MiniAnimate-timing*
189188
- Every animation is a non-blockingly scheduled series of specific actions.
190189
They are executed in a sequence of timed steps controlled by `timing` option.
@@ -208,7 +207,7 @@ Default values:
208207
animation steps. Outputs `nil` and empty table result in no animation.
209208

210209
*MiniAnimate.config.cursor*
211-
# Cursor ~
210+
Cursor ~
212211

213212
This animation is triggered for each movement of cursor inside same window
214213
and buffer. Its visualization step consists from placing single extmark (see
@@ -251,7 +250,7 @@ Configuration example: >lua
251250
After animation is done, `MiniAnimateDoneCursor` event is triggered.
252251

253252
*MiniAnimate.config.scroll*
254-
# Scroll ~
253+
Scroll ~
255254

256255
This animation is triggered for each vertical scroll of current window.
257256
Its visualization step consists from performing a small subscroll which all
@@ -311,7 +310,7 @@ Configuration example: >lua
311310
After animation is done, `MiniAnimateDoneScroll` event is triggered.
312311

313312
*MiniAnimate.config.resize*
314-
# Resize ~
313+
Resize ~
315314

316315
This animation is triggered for window resize while having same layout of
317316
same windows. For example, it won't trigger when window is opened/closed or
@@ -369,8 +368,9 @@ Configuration example: >lua
369368
<
370369
After animation is done, `MiniAnimateDoneResize` event is triggered.
371370

372-
*MiniAnimate.config.open* *MiniAnimate.config.close*
373-
# Window open/close ~
371+
*MiniAnimate.config.open*
372+
*MiniAnimate.config.close*
373+
Window open/close ~
374374

375375
These animations are similarly triggered for regular (non-floating) window
376376
open/close. Their visualization step consists from drawing empty floating

doc/mini-base16.txt

Lines changed: 6 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
*mini.base16* Base16 colorscheme creation
2-
*MiniBase16*
32

43
MIT License Copyright (c) 2021 Evgeni Chasnovski
54

6-
==============================================================================
7-
5+
------------------------------------------------------------------------------
6+
*MiniBase16*
87
Fast implementation of 'chriskempson/base16' color scheme (with Copyright
98
(C) 2012 Chris Kempson) adapted for modern Neovim Lua plugins.
109
Extra features:
@@ -55,7 +54,7 @@ Supported highlight groups:
5554
- 'stevearc/aerial.nvim'
5655
- 'williamboman/mason.nvim'
5756

58-
# Setup ~
57+
Setup ~
5958

6059
This module needs a setup with `require('mini.base16').setup({})` (replace
6160
`{}` with your `config` table). It will create global Lua table
@@ -95,7 +94,7 @@ Example: >lua
9594
},
9695
})
9796
<
98-
# Notes ~
97+
Notes ~
9998

10099
1. This is used to create some of plugin's color schemes
101100
(see |MiniBase16-color-schemes|).
@@ -119,8 +118,6 @@ a |MiniBase16| theme created with faster version of the following Lua code: >lua
119118
Activate them as regular |colorscheme| (for example, `:colorscheme minischeme`).
120119

121120
*minischeme*
122-
## minischeme ~
123-
124121
Blue and yellow main colors with high contrast and saturation palette.
125122
Palettes are: >lua
126123

@@ -131,8 +128,6 @@ Palettes are: >lua
131128
MiniBase16.mini_palette('#e2e5ca', '#002a83', 75)
132129
<
133130
*minicyan*
134-
## minicyan ~
135-
136131
Cyan and grey main colors with moderate contrast and saturation palette.
137132
Palettes are: >lua
138133

@@ -191,9 +186,7 @@ Default values:
191186
plugins = { default = true },
192187
}
193188
<
194-
# Options ~
195-
196-
## Plugin integrations ~
189+
Plugin integrations ~
197190

198191
`config.plugins` defines for which supported plugins highlight groups will
199192
be created. Limiting number of integrations slightly decreases startup time.
@@ -220,7 +213,7 @@ Create base16 palette based on the HEX (string '#RRGGBB') colors of main
220213
background and foreground with optional setting of accent chroma (see
221214
details).
222215

223-
# Algorithm design ~
216+
Algorithm design ~
224217

225218
- Main operating color space is
226219
[CIELCh(uv)](https://en.wikipedia.org/wiki/CIELUV#Cylindrical_representation_(CIELCh))

0 commit comments

Comments
 (0)