leigh/outline.nvim
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Auto generate vim docs

Browse Source
This commit is contained in:
hedyhli
2023-11-16 06:06:35 +00:00
committed by github-actions[bot]
parent fa44423c16
commit 9f4cfa9417
1 changed files with 10 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
doc/outline.txt
View File

@@ -342,7 +342,7 @@ A fallback is always used if the previous candidate returned a falsey value.
COMMANDS *outline-commands* COMMANDS *outline-commands*
- **:Outline[!]**      ✅ bang ✅ mods - **: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.
@@ -356,7 +356,7 @@ COMMANDS *outline-commands*
:belowright Outline " opens with 'belowright vsplit' :belowright Outline " opens with 'belowright vsplit'
:Outline " opens with 'botright vsplit' :Outline " opens with 'botright vsplit'
< <
- **:OutlineOpen[!]**      ✅ bang ✅ mods - **: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.
@@ -371,17 +371,13 @@ COMMANDS *outline-commands*
:OutlineOpen " opens with 'topleft vsplit' :OutlineOpen " opens with 'topleft vsplit'
< <
- **:OutlineClose**      ❌ bang ❌ mods - **:OutlineClose**: Close outline
Close outline - **:OutlineFocus**: Toggle focus between outline and code/source window
- **:OutlineFocus**      ❌ bang ❌ mods - **:OutlineFocusOutline**: Focus on outline
Toggle focus between outline and code/source window - **:OutlineFocusCode**: Focus on source window
- **:OutlineFocusOutline**      ❌ bang ❌ mods - **:OutlineStatus**: Display current provider and outline window status in the
Focus on outline messages area
- **:OutlineFocusCode**      ❌ bang ❌ mods - **:OutlineFollow[!]** (✓ bang × mods)
Focus on source window
- **:OutlineStatus**      ❌ bang ❌ mods
Display current provider and outline window status in the messages area.
- **: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.
@@ -389,7 +385,7 @@ COMMANDS *outline-commands*
`goto_location` sets cursor of code window to the position of outline window, `goto_location` sets cursor of code window to the position of outline window,
whereas this command sets position in outline window to the cursor position of whereas this command sets position in outline window to the cursor position of
code window. code window.
With bang, it can be understood as the converse of `focus_location`. With bang, it can be understood as the converse of `peek_location`.
DEFAULT KEYMAPS *outline-default-keymaps* DEFAULT KEYMAPS *outline-default-keymaps*