From f16e7ef199c5fce8d91d38d02ac9a9eb487d7335 Mon Sep 17 00:00:00 2001
From: scottmckendry <scottmckendry@users.noreply.github.com>
Date: Sun, 23 Jun 2024 00:07:23 +0000
Subject: [PATCH] docs: auto-generate vimdoc

---
 doc/telescope-resession.txt | 88 +++++++++++++++++++++++++++++++++++++
 1 file changed, 88 insertions(+)

diff --git a/doc/telescope-resession.txt b/doc/telescope-resession.txt
index 8f44ff7..8a9ff11 100644
--- a/doc/telescope-resession.txt
+++ b/doc/telescope-resession.txt
@@ -4,6 +4,10 @@
 Table of Contents                      *telescope-resession-table-of-contents*
 
 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*
@@ -11,6 +15,90 @@ Table of Contents                      *telescope-resession-table-of-contents*
 A telescope extension that adds a session picker to the wonderful
 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>
 
 vim:tw=78:ts=8:noet:ft=help:norl: