Skip to content

Commit ca218db

Browse files
echasnovskiechasnovski
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: - 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 ca218db

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

+230
-355
lines changed

‎doc/mini-ai.txt‎

Lines changed: 17 additions & 18 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.
@@ -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.
@@ -636,7 +635,7 @@ Example: >lua
636635
['|'] = gen_spec.pair('|', '|', { type = 'non-balanced' }),
637636
}
638637
})
639-
638+
<
640639
------------------------------------------------------------------------------
641640
*MiniAi.gen_spec.argument()*
642641
`MiniAi.gen_spec.argument`({opts})
@@ -685,7 +684,7 @@ Example:
685684
only alphanumeric or underscore (not dot).
686685

687686
Parameters ~
688-
{opts} `(table|nil)` Optsion. Allowed fields:
687+
{opts} `(table|nil)` Options. Allowed fields:
689688
- <name_pattern> - string pattern of character set allowed in function name.
690689
Default: `'[%w_%.]'` (alphanumeric, underscore, or dot).
691690
Note: should be enclosed in `[]`.
@@ -793,10 +792,10 @@ Return ~
793792
corresponding (`a` or `i`) treesitter capture.
794793

795794
See also ~
796-
|MiniAi-textobject-specification| for how this type of textobject
795+
- |MiniAi-textobject-specification| for how this type of textobject
797796
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
797+
- |vim.treesitter.get_query()| for how query is fetched.
798+
- |Query:iter_captures()| for how all query captures are iterated in case of
800799
no 'nvim-treesitter'.
801800

802801
------------------------------------------------------------------------------

‎doc/mini-align.txt‎

Lines changed: 3 additions & 4 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.
@@ -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

‎doc/mini-animate.txt‎

Lines changed: 4 additions & 4 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.
@@ -369,7 +368,8 @@ Configuration example: >lua
369368
<
370369
After animation is done, `MiniAnimateDoneResize` event is triggered.
371370

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

375375
These animations are similarly triggered for regular (non-floating) window

‎doc/mini-base16.txt‎

Lines changed: 2 additions & 3 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:

‎doc/mini-basics.txt‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
*mini.basics* Common configuration presets
2-
*MiniBasics*
32

43
MIT License Copyright (c) 2023 Evgeni Chasnovski
54

6-
==============================================================================
7-
5+
------------------------------------------------------------------------------
6+
*MiniBasics*
87
Install, create 'init.lua', add `require('mini.basics').setup()` and you
98
are good to go.
109

‎doc/mini-bracketed.txt‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
*mini.bracketed* Go forward/backward with square brackets
2-
*MiniBracketed*
32

43
MIT License Copyright (c) 2023 Evgeni Chasnovski
54

6-
==============================================================================
7-
5+
------------------------------------------------------------------------------
6+
*MiniBracketed*
87
Features:
98
- Configurable Lua functions to go forward/backward to a certain target.
109
Each function can be customized with:

‎doc/mini-bufremove.txt‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
*mini.bufremove* Remove buffers
2-
*MiniBufremove*
32

43
MIT License Copyright (c) 2021 Evgeni Chasnovski
54

6-
==============================================================================
7-
5+
------------------------------------------------------------------------------
6+
*MiniBufremove*
87
Features:
98
- Unshow, delete, and wipeout buffer while saving window layout
109
(opposite to builtin Neovim's commands).

‎doc/mini-clue.txt‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
*mini.clue* Show next key clues
2-
*MiniClue*
32

43
MIT License Copyright (c) 2023 Evgeni Chasnovski
54

6-
==============================================================================
7-
5+
------------------------------------------------------------------------------
6+
*MiniClue*
87
Features:
98
- Implement custom key query process to reach target key combination:
109
- Starts after customizable opt-in triggers (mode + keys).

‎doc/mini-colors.txt‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
*mini.colors* Tweak and save any color scheme
2-
*MiniColors*
32

43
MIT License Copyright (c) 2023 Evgeni Chasnovski
54

6-
==============================================================================
7-
5+
------------------------------------------------------------------------------
6+
*MiniColors*
87
Features:
98
- Create colorscheme object: either manually (|MiniColors.as_colorscheme()|)
109
or by querying present color schemes (including currently active one; see

‎doc/mini-comment.txt‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
*mini.comment* Comment lines
2-
*MiniComment*
32

43
MIT License Copyright (c) 2021 Evgeni Chasnovski
54

6-
==============================================================================
7-
5+
------------------------------------------------------------------------------
6+
*MiniComment*
87
Features:
98
- Commenting in Normal mode respects |count| and is dot-repeatable.
109

0 commit comments

Comments
 (0)