From 9b843321d9082592a138e0fa9d2b79ff7198c9b6 Mon Sep 17 00:00:00 2001 From: hedyhli Date: Wed, 15 Nov 2023 14:33:47 +0000 Subject: [PATCH] Auto generate vim docs --- doc/outline.txt | 37 +++++++++++++++++++++++++++++-------- 1 file changed, 29 insertions(+), 8 deletions(-) diff --git a/doc/outline.txt b/doc/outline.txt index a948175..ec00959 100644 --- a/doc/outline.txt +++ b/doc/outline.txt @@ -342,25 +342,46 @@ A fallback is always used if the previous candidate returned a falsey value. COMMANDS *outline-commands* -- **:Outline[!]** +- **:Outline[!]**      ✅ bang ✅ mods 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 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 after opening the outline window. Set `focus_on_open = true` to always use this 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 -- **:OutlineFocus** +- **:OutlineFocus**      ❌ bang ❌ mods Toggle focus between outline and code/source window -- **:OutlineFocusOutline** +- **:OutlineFocusOutline**      ❌ bang ❌ mods Focus on outline -- **:OutlineFocusCode** +- **:OutlineFocusCode**      ❌ bang ❌ mods Focus on source window -- **:OutlineStatus** +- **:OutlineStatus**      ❌ bang ❌ mods 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 on the outline window. With bang (`!`), retain focus on the code window.