Skip to content

Commit

Permalink
build(docs): auto generate vim documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Jun 5, 2024
1 parent 62ad3ea commit df01798
Showing 1 changed file with 25 additions and 9 deletions.
34 changes: 25 additions & 9 deletions doc/scalpel.nvim.txt
Original file line number Diff line number Diff line change
Expand Up @@ -46,23 +46,39 @@ The following example shows the installation process using lazy.nvim
<


[!NOTE] You can set the keymap to anything you wish.

USAGE *scalpel.nvim-scalpel.nvim-usage*

Using **scalpel.nvim** is simple:

1. Move the cursor over the word you wish to replace.
2. Trigger the substitution with the `<leader>e` keymap.
3. Begin typing your desired substitution and hit return. Note that the original word is being captured, so if you would like to incorporate it into your replacement, use `\1`.
NORMAL MODE

1. Move the cursor over the word to replace
2. Trigger the substitution with your keymap
3. Begin typing the desired substitution and hit return


VISUAL MODE

1. Use visual mode (`v`) to select the word(s) to replace within a _single line_
2. Trigger the substitution with your keymap
3. Begin typing the desired substitution and hit return


This plugin also supports visual mode selection for substitutions within a
single line.
VISUAL LINE MODE

1. Highlight word(s) to substitute with `*` or `/`
2. Use visual line mode (`V`) to highlight the lines with the word(s) to substitute
3. Trigger the substitution with your keymap
4. Begin typing the desired substitution and hit return

ACKNOWLEDGMENTS *scalpel.nvim-scalpel.nvim-acknowledgments*

[!TIP] The word(s) being replaced during substitution are available in the
replacement text using `&`.
ACKNOWLEDGMENTS *scalpel.nvim-scalpel.nvim-acknowledgments*
This project was inspired by Scalpel <https://github.com/wincent/scalpel>, a
Vimscript plugin I’ve used for many years. **scalpel.nvim** is my version
reimagined and implemented in Lua for fun.
Vimscript plugin I’ve used for many years. **scalpel.nvim** is my version,
which was reimagined and implemented in Lua for fun.

==============================================================================
2. Links *scalpel.nvim-links*
Expand Down

0 comments on commit df01798

Please sign in to comment.