Auto generate vim docs

This commit is contained in:
hedyhli
2023-11-15 14:33:47 +00:00
committed by github-actions[bot]
parent 7c703361e9
commit 9b843321d9

View File

@@ -342,25 +342,46 @@ A fallback is always used if the previous candidate returned a falsey value.
COMMANDS *outline-commands* COMMANDS *outline-commands*
- **:Outline[!]** - **:Outline[!]**      ✅ bang ✅ mods
Toggle outline. With bang (`!`) the cursor focus stays in your original window Toggle outline. With bang (`!`) the cursor focus stays in your original window
after opening the outline window. Set `focus_on_open = true` to always use this after opening the outline window. Set `focus_on_open = true` to always use this
behaviour. behaviour.
- **:OutlineOpen[!]** You can use command modifiers `topleft`/`aboveleft`/`botright`/`belowright` on
this command to control how the outline window split is created. Other
modifiers are ignored.
Example:
>vim
" in config: position='right'
:topleft Outline " opens with 'topleft vsplit'
:belowright Outline " opens with 'belowright vsplit'
:Outline " opens with 'botright vsplit'
<
- **:OutlineOpen[!]**      ✅ bang ✅ mods
Open outline. With bang (`!`) the cursor focus stays in your original window Open outline. With bang (`!`) the cursor focus stays in your original window
after opening the outline window. Set `focus_on_open = true` to always use this after opening the outline window. Set `focus_on_open = true` to always use this
behaviour. behaviour.
- **:OutlineClose** You can use command modifiers `topleft`/`aboveleft`/`botright`/`belowright` on
this command to control how the outline window split is created. Other
modifiers are ignored.
>vim
" in config: position='left'
:aboveleft OutlineOpen " opens with 'aboveleft vsplit'
:belowright OutlineOpen " opens with 'belowright vsplit'
:OutlineOpen " opens with 'topleft vsplit'
<
- **:OutlineClose**      ❌ bang ❌ mods
Close outline Close outline
- **:OutlineFocus** - **:OutlineFocus**      ❌ bang ❌ mods
Toggle focus between outline and code/source window Toggle focus between outline and code/source window
- **:OutlineFocusOutline** - **:OutlineFocusOutline**      ❌ bang ❌ mods
Focus on outline Focus on outline
- **:OutlineFocusCode** - **:OutlineFocusCode**      ❌ bang ❌ mods
Focus on source window Focus on source window
- **:OutlineStatus** - **:OutlineStatus**      ❌ bang ❌ mods
Display current provider and outline window status in the messages area. Display current provider and outline window status in the messages area.
- **:OutlineFollow[!]** - **:OutlineFollow[!]**      ✅ bang ❌ mods
Go to corresponding node in outline based on cursor position in code, and focus Go to corresponding node in outline based on cursor position in code, and focus
on the outline window. on the outline window.
With bang (`!`), retain focus on the code window. With bang (`!`), retain focus on the code window.