Skip to content

Commit 1518409

Browse files
csesshgithub-actions[bot]
authored andcommitted
Chores: Auto generate docs
1 parent 7304be4 commit 1518409

File tree

1 file changed

+70
-0
lines changed

1 file changed

+70
-0
lines changed

doc/stopinsert.nvim.txt

+70
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
*stopinsert.nvim.txt* For NVIM v0.8.0 Last change: 2024 October 05
2+
3+
==============================================================================
4+
Table of Contents *stopinsert.nvim-table-of-contents*
5+
6+
1. stopinsert.nvim |stopinsert.nvim-stopinsert.nvim|
7+
- Intro |stopinsert.nvim-stopinsert.nvim-intro|
8+
- Installation |stopinsert.nvim-stopinsert.nvim-installation|
9+
- Configuration |stopinsert.nvim-stopinsert.nvim-configuration|
10+
11+
==============================================================================
12+
1. stopinsert.nvim *stopinsert.nvim-stopinsert.nvim*
13+
14+
15+
INTRO *stopinsert.nvim-stopinsert.nvim-intro*
16+
17+
`stopinsert` is a vim command (see vimdoc
18+
<https://vimdoc.sourceforge.net/htmldoc/insert.html>) that works like typing
19+
`<Esc>` in Insert mode.
20+
21+
This plugin automatically kicks you out of Insert mode after certain amount of
22+
time of inactivity.
23+
24+
25+
INSTALLATION *stopinsert.nvim-stopinsert.nvim-installation*
26+
27+
1. Let your favourite package manager do the work:
28+
29+
>lua
30+
-- lazy.nvim
31+
{
32+
"csessh/stopinsert.nvim",
33+
opts = {}
34+
},
35+
<
36+
37+
1. Setup the plugin in your `init.lua`. This step is not needed with lazy.nvim if `opts` is set.
38+
39+
>lua
40+
require("stopinsert").setup()
41+
<
42+
43+
44+
CONFIGURATION *stopinsert.nvim-stopinsert.nvim-configuration*
45+
46+
--------------------------------------------------------------------------------------------------------------------------------------
47+
Items Type Default Value Description
48+
------------------------ ---------- --------------------------------------------------------------------------------- ----------------
49+
idle_time_ms number 5000 (5 seconds) Maximum time (in
50+
milliseconds)
51+
before you are
52+
forced out of
53+
Insert mode back
54+
to Normal mode.
55+
56+
disabled_filetypes list { "TelescopePrompt", "checkhealth", "help", "lspinfo", "mason", "neo%-tree*", } List of
57+
filetypes to
58+
exclude the
59+
effect of this
60+
plugin.
61+
--------------------------------------------------------------------------------------------------------------------------------------
62+
**NOTE:** By default, `stopinsert.nvim` excludes a list of filetypes, as shown
63+
in the table above.
64+
65+
If you configure this attribute in `opts` with your package manager, like so,
66+
your list will replace `stopinsert.nvim` defaults.
67+
68+
Generated by panvimdoc <https://github.com/kdheepak/panvimdoc>
69+
70+
vim:tw=78:ts=8:noet:ft=help:norl:

0 commit comments

Comments
 (0)