doc: documented vim.g.autosave_state

This commit is contained in:
Pocco81
2021-11-02 19:21:31 -05:00
parent e68e2c3e23
commit 8df684bcb3
+13 -6
View File
@@ -60,9 +60,11 @@
* [For init.lua](#for-initlua) * [For init.lua](#for-initlua)
* [For init.vim](#for-initvim) * [For init.vim](#for-initvim)
* [Updating](#updating) * [Updating](#updating)
* [Usage (commands)](#-usage-commands) * [Usage](#-usage)
* [Default](#default) * [Commands](#commands)
* [Extra](#extra) * [Default](#default)
* [Extra](#extra)
* [General](#general)
* [Configuration](#-configuration) * [Configuration](#-configuration)
* [General](#general) * [General](#general)
* [Conditions](#conditions) * [Conditions](#conditions)
@@ -206,16 +208,21 @@ This depends on your plugin manager. If, for example, you are using Packer.nvim,
:PackerUpdate :PackerUpdate
``` ```
# 🤖 Usage (commands) # 🤖 Usage
## Commands
All the commands follow the *camel casing* naming convention and have the `AS` prefix so that it's easy to remember that they are part of this plugin. These are all of them: All the commands follow the *camel casing* naming convention and have the `AS` prefix so that it's easy to remember that they are part of this plugin. These are all of them:
## Default ### Default
+ `:ASToggle`: toggles AutoSave.nvim on and off. + `:ASToggle`: toggles AutoSave.nvim on and off.
## Extra ### Extra
+ `:ASOn`: turns AutoSave.nvim on. + `:ASOn`: turns AutoSave.nvim on.
+ `:ASOff`: turns AutoSave.nvim off. + `:ASOff`: turns AutoSave.nvim off.
## General
+ `vim.g.autosave_state`: use this to check whether AutoSave is on (`true`) or off (`false`).
# 🐬 Configuration # 🐬 Configuration
Although settings already have self-explanatory names, here is where you can find info about each one of them and their classifications! Although settings already have self-explanatory names, here is where you can find info about each one of them and their classifications!