diff --git a/doc/persistence.nvim.txt b/doc/persistence.nvim.txt new file mode 100644 index 0000000..b900b2d --- /dev/null +++ b/doc/persistence.nvim.txt @@ -0,0 +1,98 @@ +*persistence.nvim.txt* For Neovim >= 0.8.0 Last change: 2023 January 04 + +============================================================================== +Table of Contents *persistence.nvim-table-of-contents* + +1. Persistence |persistence.nvim-persistence| + - Features |persistence.nvim-features| + - Requirements |persistence.nvim-requirements| + - Installation |persistence.nvim-installation| + - Configuration |persistence.nvim-configuration| + - Usage |persistence.nvim-usage| + +============================================================================== +1. Persistence *persistence.nvim-persistence* + +**Persistence** is a simple lua plugin for automated session management. + +FEATURES *persistence.nvim-features* + + +- automatically saves the active session under `.config/nvim/sessions` on exit +- simple API to restore the current or last session + + +REQUIREMENTS *persistence.nvim-requirements* + + +- Neovim >= 0.5.0 + + +INSTALLATION *persistence.nvim-installation* + +Install the plugin with your preferred package manager: + +PACKER ~ + +>lua + -- Lua + use({ + "folke/persistence.nvim", + event = "BufReadPre", -- this will only start session saving when an actual file was opened + module = "persistence", + config = function() + require("persistence").setup() + end, + }) +< + + +VIM-PLUG ~ + +>vim + " Vim Script + Plug 'folke/persistence.nvim' + + lua << EOF + require("persistence").setup { + -- your configuration comes here + -- or leave it empty to use the default settings + -- refer to the configuration section below + } + EOF +< + + +CONFIGURATION *persistence.nvim-configuration* + +Persistence comes with the following defaults: + +>lua + { + dir = vim.fn.expand(vim.fn.stdpath("config") .. "/sessions/"), -- directory where session files are saved + options = { "buffers", "curdir", "tabpages", "winsize" }, -- sessionoptions used for saving + } +< + + +USAGE *persistence.nvim-usage* + +**Persistence** works well with plugins like `startify` or `dashboard`. It will +never restore a session automatically, but you can of course write an autocmd +that does exactly that if you want. + +>lua + -- restore the session for the current directory + vim.api.nvim_set_keymap("n", "qs", [[lua require("persistence").load()]], {}) + + -- restore the last session + vim.api.nvim_set_keymap("n", "ql", [[lua require("persistence").load({ last = true })]], {}) + + -- stop Persistence => session won't be saved on exit + vim.api.nvim_set_keymap("n", "qd", [[lua require("persistence").stop()]], {}) +< + + +Generated by panvimdoc + +vim:tw=78:ts=8:noet:ft=help:norl: