docs: auto-generate vimdoc

main
scottmckendry 2024-06-23 00:07:23 +00:00 committed by github-actions[bot]
parent 3ccfefab97
commit f16e7ef199
1 changed files with 88 additions and 0 deletions

View File

@ -4,6 +4,10 @@
Table of Contents *telescope-resession-table-of-contents* Table of Contents *telescope-resession-table-of-contents*
1. telescope-resession.nvim |telescope-resession-telescope-resession.nvim| 1. telescope-resession.nvim |telescope-resession-telescope-resession.nvim|
- Extension Installation|telescope-resession-telescope-resession.nvim-extension-installation|
- Recommended Resession Configuration|telescope-resession-telescope-resession.nvim-recommended-resession-configuration|
- Usage |telescope-resession-telescope-resession.nvim-usage|
- Customization |telescope-resession-telescope-resession.nvim-customization|
============================================================================== ==============================================================================
1. telescope-resession.nvim *telescope-resession-telescope-resession.nvim* 1. telescope-resession.nvim *telescope-resession-telescope-resession.nvim*
@ -11,6 +15,90 @@ Table of Contents *telescope-resession-table-of-contents*
A telescope extension that adds a session picker to the wonderful A telescope extension that adds a session picker to the wonderful
resession.nvim <https://github.com/stevearc/resession.nvim> plugin. resession.nvim <https://github.com/stevearc/resession.nvim> plugin.
EXTENSION INSTALLATION*telescope-resession-telescope-resession.nvim-extension-installation*
>lua
{
"nvim-telescope/telescope.nvim",
dependencies = { "scottmckendry/telescope-resession.nvim" },
config = function()
telescope.setup({
-- Other telescope config...
extensions = {
resession = {
prompt_title = "Find Sessions", -- telescope prompt title
dir = "session", -- directory where resession stores sessions
},
},
},
})
end,
}
<
RECOMMENDED RESESSION CONFIGURATION*telescope-resession-telescope-resession.nvim-recommended-resession-configuration*
>lua
return {
"stevearc/resession.nvim",
config = function()
local resession = require("resession")
resession.setup({})
-- Automatically save sessions on by working directory on exit
vim.api.nvim_create_autocmd("VimLeavePre", {
callback = function()
resession.save(vim.fn.getcwd(), { notify = true })
end,
})
-- Automatically load sessions on startup by working directory
vim.api.nvim_create_autocmd("VimEnter", {
callback = function()
-- Only load the session if nvim was started with no args
if vim.fn.argc(-1) == 0 then
resession.load(vim.fn.getcwd(), { silence_errors = true })
end
end,
nested = true,
})
end,
}
<
USAGE *telescope-resession-telescope-resession.nvim-usage*
Vim command:
>vim
:Telescope resession
<
Lua:
>lua
require("telescope").extensions.resession.resession()
<
CUSTOMIZATION *telescope-resession-telescope-resession.nvim-customization*
>lua
extensions = {
resession = {
prompt_title = "Your custom prompt title",
-- Apply custom path substitutions to the session paths
path_substitutions = {
{ find = "/home/username", replace = "🏠" },
},
},
},
<
Generated by panvimdoc <https://github.com/kdheepak/panvimdoc> Generated by panvimdoc <https://github.com/kdheepak/panvimdoc>
vim:tw=78:ts=8:noet:ft=help:norl: vim:tw=78:ts=8:noet:ft=help:norl: