zoriya/auto-save.nvim
1
0
Fork 0
mirror of https://github.com/zoriya/auto-save.nvim.git synced 2025-12-06 06:36:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore(doc): auto-generate vimdoc

Browse Source
This commit is contained in:
github-actions[bot]
2023-11-08 08:30:42 +00:00
parent 723168365b
commit e98cafef75
1 changed files with 23 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
doc/auto-save.nvim.txt
View File

@@ -1,4 +1,4 @@
*auto-save.nvim.txt* For Neovim >= 0.8.0 Last change: 2023 July 27 *auto-save.nvim.txt* For Neovim >= 0.8.0 Last change: 2023 November 08
============================================================================== ==============================================================================
Table of Contents *auto-save.nvim-table-of-contents* Table of Contents *auto-save.nvim-table-of-contents*
@@ -10,6 +10,7 @@ Table of Contents *auto-save.nvim-table-of-contents*
- Packer.nvim |auto-save.nvim-installation-packer.nvim| - Packer.nvim |auto-save.nvim-installation-packer.nvim|
- vim-plug |auto-save.nvim-installation-vim-plug| - vim-plug |auto-save.nvim-installation-vim-plug|
4. Configuration |auto-save.nvim-configuration| 4. Configuration |auto-save.nvim-configuration|
- Trigger Events |auto-save.nvim-configuration-trigger-events|
- Condition |auto-save.nvim-configuration-condition| - Condition |auto-save.nvim-configuration-condition|
5. Usage |auto-save.nvim-usage| 5. Usage |auto-save.nvim-usage|
6. Events / Callbacks |auto-save.nvim-events-/-callbacks| 6. Events / Callbacks |auto-save.nvim-events-/-callbacks|
@@ -119,9 +120,29 @@ VIM-PLUG *auto-save.nvim-installation-vim-plug*
< <
TRIGGER EVENTS *auto-save.nvim-configuration-trigger-events*
The `trigger_events` field of the configuration allows the user to customize at
which events **auto-save** saves. While the default are very sane and should be
enough for most usecases, finetuning for extended possibilities is supported.
It is also possible to pass a pattern to a trigger event, if you only want to
execute the event on special file patterns:
>lua
{
trigger_events = {
immediate_save = {
{ "BufLeave", pattern = {".c", ".h"} }
}
}
}
<
CONDITION *auto-save.nvim-configuration-condition* CONDITION *auto-save.nvim-configuration-condition*
The condition field of the configuration allows the user to exclude The `condition` field of the configuration allows the user to exclude
**auto-save** from saving specific buffers. **auto-save** from saving specific buffers.
Here is an example using a helper function from `auto-save.utils.data` that Here is an example using a helper function from `auto-save.utils.data` that