mirrors/neovim
1
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2026-04-22 15:25:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: replace <pre> with ``` (#25136)

Browse Source
This commit is contained in:
Gregory Anders
2023-09-14 08:23:01 -05:00
committed by GitHub
parent 9fc321c976
commit 2e92065686
43 changed files with 1350 additions and 1245 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
runtime/lua/vim/highlight.lua
View File

@@ -1,23 +1,24 @@
---@defgroup vim.highlight
---
---@brief
---Nvim includes a function for highlighting a selection on yank.
--- Nvim includes a function for highlighting a selection on yank.
---
---To enable it, add the following to your `init.vim`:
---<pre>vim
--- au TextYankPost * silent! lua vim.highlight.on_yank()
---</pre>
--- To enable it, add the following to your `init.vim`:
---
---You can customize the highlight group and the duration of
---the highlight via:
---<pre>vim
--- au TextYankPost * silent! lua vim.highlight.on_yank {higroup="IncSearch", timeout=150}
---</pre>
--- ```vim
--- au TextYankPost * silent! lua vim.highlight.on_yank()
--- ```
---
---If you want to exclude visual selections from highlighting on yank, use:
---<pre>vim
--- au TextYankPost * silent! lua vim.highlight.on_yank {on_visual=false}
---</pre>
--- You can customize the highlight group and the duration of the highlight via:
---
--- ```vim
--- au TextYankPost * silent! lua vim.highlight.on_yank {higroup="IncSearch", timeout=150}
--- ```
---
--- If you want to exclude visual selections from highlighting on yank, use:
---
--- ```vim
--- au TextYankPost * silent! lua vim.highlight.on_yank {on_visual=false}
--- ```
local api = vim.api