Skip to content

Commit c2616e6

Browse files
IsrothyIsrothy
committed
doc: Use new vim command in README.md
1 parent e7670a0 commit c2616e6

File tree

1 file changed

+118
-57
lines changed

1 file changed

+118
-57
lines changed

‎README.md‎

Lines changed: 118 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -116,33 +116,33 @@ With Lazy:
116116
-- Optional. You can alse set your own keybindings
117117
keys = {
118118
-- Global Minimap Controls
119-
{ "<leader>nm", "<cmd>Neominimap toggle<cr>", desc = "Toggle global minimap" },
120-
{ "<leader>no", "<cmd>Neominimap on<cr>", desc = "Enable global minimap" },
121-
{ "<leader>nc", "<cmd>Neominimap off<cr>", desc = "Disable global minimap" },
122-
{ "<leader>nr", "<cmd>Neominimap refresh<cr>", desc = "Refresh global minimap" },
119+
{ "<leader>nm", "<cmd>Neominimap Toggle<cr>", desc = "Toggle global minimap" },
120+
{ "<leader>no", "<cmd>Neominimap Enable<cr>", desc = "Enable global minimap" },
121+
{ "<leader>nc", "<cmd>Neominimap Disable<cr>", desc = "Disable global minimap" },
122+
{ "<leader>nr", "<cmd>Neominimap Refresh<cr>", desc = "Refresh global minimap" },
123123

124124
-- Window-Specific Minimap Controls
125-
{ "<leader>nwt", "<cmd>Neominimap winToggle<cr>", desc = "Toggle minimap for current window" },
126-
{ "<leader>nwr", "<cmd>Neominimap winRefresh<cr>", desc = "Refresh minimap for current window" },
127-
{ "<leader>nwo", "<cmd>Neominimap winOn<cr>", desc = "Enable minimap for current window" },
128-
{ "<leader>nwc", "<cmd>Neominimap winOff<cr>", desc = "Disable minimap for current window" },
125+
{ "<leader>nwt", "<cmd>Neominimap WinToggle<cr>", desc = "Toggle minimap for current window" },
126+
{ "<leader>nwr", "<cmd>Neominimap WinRefresh<cr>", desc = "Refresh minimap for current window" },
127+
{ "<leader>nwo", "<cmd>Neominimap WinEnable<cr>", desc = "Enable minimap for current window" },
128+
{ "<leader>nwc", "<cmd>Neominimap WinDisable<cr>", desc = "Disable minimap for current window" },
129129

130130
-- Tab-Specific Minimap Controls
131-
{ "<leader>ntt", "<cmd>Neominimap tabToggle<cr>", desc = "Toggle minimap for current tab" },
132-
{ "<leader>ntr", "<cmd>Neominimap tabRefresh<cr>", desc = "Refresh minimap for current tab" },
133-
{ "<leader>nto", "<cmd>Neominimap tabOn<cr>", desc = "Enable minimap for current tab" },
134-
{ "<leader>ntc", "<cmd>Neominimap tabOff<cr>", desc = "Disable minimap for current tab" },
131+
{ "<leader>ntt", "<cmd>Neominimap TabToggle<cr>", desc = "Toggle minimap for current tab" },
132+
{ "<leader>ntr", "<cmd>Neominimap TabRefresh<cr>", desc = "Refresh minimap for current tab" },
133+
{ "<leader>nto", "<cmd>Neominimap TabEnable<cr>", desc = "Enable minimap for current tab" },
134+
{ "<leader>ntc", "<cmd>Neominimap TabDisable<cr>", desc = "Disable minimap for current tab" },
135135

136136
-- Buffer-Specific Minimap Controls
137-
{ "<leader>nbt", "<cmd>Neominimap bufToggle<cr>", desc = "Toggle minimap for current buffer" },
138-
{ "<leader>nbr", "<cmd>Neominimap bufRefresh<cr>", desc = "Refresh minimap for current buffer" },
139-
{ "<leader>nbo", "<cmd>Neominimap bufOn<cr>", desc = "Enable minimap for current buffer" },
140-
{ "<leader>nbc", "<cmd>Neominimap bufOff<cr>", desc = "Disable minimap for current buffer" },
137+
{ "<leader>nbt", "<cmd>Neominimap BufToggle<cr>", desc = "Toggle minimap for current buffer" },
138+
{ "<leader>nbr", "<cmd>Neominimap BufRefresh<cr>", desc = "Refresh minimap for current buffer" },
139+
{ "<leader>nbo", "<cmd>Neominimap BufEnable<cr>", desc = "Enable minimap for current buffer" },
140+
{ "<leader>nbc", "<cmd>Neominimap BufDisable<cr>", desc = "Disable minimap for current buffer" },
141141

142142
---Focus Controls
143-
{ "<leader>nf", "<cmd>Neominimap focus<cr>", desc = "Focus on minimap" },
144-
{ "<leader>nu", "<cmd>Neominimap unfocus<cr>", desc = "Unfocus minimap" },
145-
{ "<leader>ns", "<cmd>Neominimap toggleFocus<cr>", desc = "Switch focus on minimap" },
143+
{ "<leader>nf", "<cmd>Neominimap Focus<cr>", desc = "Focus on minimap" },
144+
{ "<leader>nu", "<cmd>Neominimap Unfocus<cr>", desc = "Unfocus minimap" },
145+
{ "<leader>ns", "<cmd>Neominimap ToggleFocus<cr>", desc = "Switch focus on minimap" },
146146
},
147147
init = function()
148148
-- The following options are recommended when layout == "float"
@@ -447,42 +447,103 @@ vim.g.neominimap = {
447447
<details>
448448
<summary>Click to expand</summary>
449449

450-
| Command | Description | Arguments |
451-
| ------------------------------------- | --------------------------------------------------------------------------------------------------------------- | -------------------------- |
452-
| `Neominimap on` | Turn on minimaps globally. | None |
453-
| `Neominimap off` | Turn off minimaps globally. | None |
454-
| `Neominimap toggle` | Toggle minimaps globally. | None |
455-
| `Neominimap refresh` | Refresh minimaps globally. | None |
456-
| `Neominimap bufOn [buffer_list]` | Enable the minimap for specified buffers. If no buffers are specified, enable for the current buffer. | Optional: List of buffers |
457-
| `Neominimap bufOff [buffer_list]` | Disable the minimap for specified buffers. If no buffers are specified, disable for the current buffer. | Optional: List of buffers |
458-
| `Neominimap bufToggle [buffer_list]` | Toggle the minimap for specified buffers. If no buffers are specified, toggle for the current buffer. | Optional: List of buffers |
459-
| `Neominimap bufRefresh [buffer_list]` | Refresh the minimap buffers for specified buffers. If no buffers are specified, refresh for the current buffer. | Optional: List of buffers |
460-
| `Neominimap TabOn [tab_list]` | Enable the minimap for specified tabpage. If no tabpages are specified, enable for the current tab. | Optional: List of tabpages |
461-
| `Neominimap TabOff [tab_list]` | Disable the minimap for specified tabpages. If no tabpages are specified, disable for the current tab. | Optional: List of tabpages |
462-
| `Neominimap TabToggle [tab_list]` | Toggle the minimap for specified tabpages. If no tabpages are specified, toggle for the current tab. | Optional: List of tabpages |
463-
| `Neominimap TabRefresh [tab_list]` | Refresh the minimap tabs for specified tabs. If no tabs are specified, refresh for the current tab. | Optional: List of tabpages |
464-
| `Neominimap winOn [window_list]` | Enable the minimap for specified windows. If no windows are specified, enable for the current window. | Optional: List of windows |
465-
| `Neominimap winOff [window_list]` | Disable the minimap for specified windows. If no windows are specified, disable for the current window. | Optional: List of windows |
466-
| `Neominimap winToggle [window_list]` | Toggle the minimap for specified windows. If no windows are specified, toggle for the current window. | Optional: List of windows |
467-
| `Neominimap winRefresh [window_list]` | Refresh the minimap windows for specified windows. If no windows are specified, refresh for the current window. | Optional: List of windows |
468-
| `Neominimap focus` | Focus on the minimap. Set cursor to the minimap window. | None |
469-
| `Neominimap unfocus` | Unfocus the minimap. Set cursor back. | None |
470-
| `Neominimap toggleFocus` | Toggle minimap focus | None |
471-
472-
`Neominimap bufRefresh` does the following:
473-
474-
- Creating or wiping out buffers as needed.
475-
- Rendering minimap text and applying highlights.
476-
477-
`Neominimap tabRefresh` does the following:
478-
479-
- Creating or wiping out windows in tabpages as needed.
480-
481-
`Neominimap winRefresh` does the following:
482-
483-
- Opening or closing windows as needed.
484-
- Updating window configurations, such as positions and sizes.
485-
- Attaching windows to the correct buffers.
450+
- **Global Commands:**
451+
452+
- `Neominimap Enable`
453+
454+
- **Description:** Enable minimaps globally.
455+
- **Arguments:** None
456+
457+
- `Neominimap Disable`
458+
459+
- **Description:** Disable minimaps globally.
460+
- **Arguments:** None
461+
462+
- `Neominimap Toggle`
463+
464+
- **Description:** Toggle minimaps globally.
465+
- **Arguments:** None
466+
467+
- `Neominimap Refresh`
468+
469+
- **Description:** Refresh minimaps globally.
470+
- **Arguments:** None
471+
472+
- **Buffer Commands:**
473+
474+
- `Neominimap BufEnable [buffer_list]`
475+
476+
- **Description:** Enable the minimap for specified buffers. If no buffers are specified, enable for the current buffer.
477+
- **Arguments:** Optional: List of buffers
478+
479+
- `Neominimap BufDisable [buffer_list]`
480+
481+
- **Description:** Disable the minimap for specified buffers. If no buffers are specified, disable for the current buffer.
482+
- **Arguments:** Optional: List of buffers
483+
484+
- `Neominimap BufToggle [buffer_list]`
485+
486+
- **Description:** Toggle the minimap for specified buffers. If no buffers are specified, toggle for the current buffer.
487+
- **Arguments:** Optional: List of buffers
488+
489+
- `Neominimap BufRefresh [buffer_list]`
490+
491+
- **Description:** Refresh the minimap buffers for specified buffers. If no buffers are specified, refresh for the current buffer. It does the following:
492+
1. Creating or wiping out buffers as needed.
493+
2. Rendering minimap text and applying highlights.
494+
- **Arguments:** Optional: List of buffers
495+
496+
- **Tab Commands:**
497+
498+
- `Neominimap TabEnable [tab_list]`
499+
- **Description:** Enable the minimap for specified tabpage. If no tabpages are specified, enable for the current tab.
500+
- **Arguments:** Optional: List of tabpages
501+
- `Neominimap TabDisable [tab_list]`
502+
- **Description:** Disable the minimap for specified tabpages. If no tabpages are specified, disable for the current tab.
503+
- **Arguments:** Optional: List of tabpages
504+
- `Neominimap TabToggle [tab_list]`
505+
506+
- **Description:** Toggle the minimap for specified tabpages. If no tabpages are specified, toggle for the current tab.
507+
- **Arguments:** Optional: List of tabpages
508+
509+
- `Neominimap TabRefresh [tab_list]`
510+
- **Description:** Refresh the minimap tabs for specified tabs. If no tabs are specified, refresh for the current tab. It does the following:
511+
1. Creating or wiping out windows in tabpages as needed.
512+
- **Arguments:** Optional: List of tabpages
513+
514+
- **Window Commands:**
515+
516+
- `Neominimap WinEnable [window_list]`
517+
- **Description:** Enable the minimap for specified windows. If no windows are specified, enable for the current window.
518+
- **Arguments:** Optional: List of windows
519+
- `Neominimap WinDisable [window_list]`
520+
- **Description:** Disable the minimap for specified windows. If no windows are specified, disable for the current window.
521+
- **Arguments:** Optional: List of windows
522+
- `Neominimap WinToggle [window_list]`
523+
524+
- **Description:** Toggle the minimap for specified windows. If no windows are specified, toggle for the current window.
525+
- **Arguments:** Optional: List of windows
526+
527+
- `Neominimap WinRefresh [window_list]`
528+
- **Description:** Refresh the minimap windows for specified windows. If no windows are specified, refresh for the current window. It does the following:
529+
1. Opening or closing windows as needed.
530+
2. Updating window configurations, such as positions and sizes.
531+
3. Attaching windows to the correct buffers.
532+
- **Arguments:** Optional: List of windows
533+
534+
- **Focus Commands:**
535+
536+
- `Neominimap Focus`
537+
- **Description:** Focus on the minimap. Set cursor to the minimap window.
538+
- **Arguments:** None
539+
- `Neominimap Unfocus`
540+
541+
- **Description:** Unfocus the minimap. Set cursor back.
542+
- **Arguments:** None
543+
544+
- `Neominimap ToggleFocus`
545+
- **Description:** Toggle minimap focus.
546+
- **Arguments:** None
486547

487548
### Usage Examples
488549

@@ -495,13 +556,13 @@ To turn on the minimap globally:
495556
To disable the minimap for the current buffer:
496557

497558
```vim
498-
:Neominimap bufOff
559+
:Neominimap BufOff
499560
```
500561

501562
To refresh the minimap for windows 3 and 4:
502563

503564
```vim
504-
:Neominimap winRefresh 3 4
565+
:Neominimap WinRefresh 3 4
505566
```
506567

507568
</details>

0 commit comments

Comments
 (0)