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

docs: Better formatting for commands

Browse Source
This commit is contained in:
hedy
2023-11-16 14:06:00 +08:00
parent 1d571e4292
commit fa44423c16
1 changed files with 9 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@@ -383,7 +383,7 @@ A fallback is always used if the previous candidate returned a falsey value.
## Commands ## Commands
- **:Outline[!]**      ✅ bang ✅ mods - **:Outline[!]** (✓ bang ✓ mods)
Toggle outline. With bang (`!`) the cursor focus stays in your Toggle outline. With bang (`!`) the cursor focus stays in your
original window after opening the outline window. Set `focus_on_open = true` to original window after opening the outline window. Set `focus_on_open = true` to
@@ -401,7 +401,7 @@ A fallback is always used if the previous candidate returned a falsey value.
: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 Open outline. With bang (`!`) the cursor focus stays in your original
window after opening the outline window. Set `focus_on_open = true` to always window after opening the outline window. Set `focus_on_open = true` to always
@@ -418,27 +418,17 @@ A fallback is always used if the previous candidate returned a falsey value.
: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 messages area
Focus on outline - **:OutlineFollow[!]** (✓ bang × mods)
- **:OutlineFocusCode**      ❌ 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 Go to corresponding node in outline based on cursor position in code, and
focus on the outline window. focus on the outline window.
@@ -450,7 +440,7 @@ A fallback is always used if the previous candidate returned a falsey value.
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 ## Default keymaps