diff --git a/doc/persistence.txt b/doc/persistence.txt deleted file mode 100644 index acbe0d8..0000000 --- a/doc/persistence.txt +++ /dev/null @@ -1,99 +0,0 @@ -*persistence.txt* For NVIM v0.8.0 Last change: 2023 January 04 - -============================================================================== -Table of Contents *persistence-table-of-contents* - -1. 💾 Persistence |persistence-💾-persistence| - - ✨ Features |persistence-✨-features| - - ⚡️ Requirements |persistence-⚡️-requirements| - - 📦 Installation |persistence-📦-installation| - - ⚙️ Configuration |persistence-⚙️-configuration| - - 🚀 Usage |persistence-🚀-usage| - -============================================================================== -1. 💾 Persistence *persistence-💾-persistence* - -**Persistence** is a simple lua plugin for automated session management. - -✨ FEATURES *persistence-✨-features* - - -- automatically saves the active session under `.config/nvim/sessions` on exit -- simple API to restore the current or last session - - -⚡️ REQUIREMENTS *persistence-⚡️-requirements* - - -- Neovim >= 0.5.0 - - -📦 INSTALLATION *persistence-📦-installation* - -Install the plugin with your preferred package manager: - -PACKER ~ - -> - -- 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 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-⚙️-configuration* - -Persistence comes with the following defaults: - -> - { - dir = vim.fn.expand(vim.fn.stdpath("state") .. "/sessions/"), -- directory where session files are saved - options = { "buffers", "curdir", "tabpages", "winsize" }, -- sessionoptions used for saving - pre_save = nil, -- a function to call before saving the session - } -< - - -🚀 USAGE *persistence-🚀-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. - -> - -- 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: