chore(doc): auto generate docs

jellydn · Nov 8, 2023 · c3a0fbc · c3a0fbc
1 parent 46fd844
commit c3a0fbc
Showing 1 changed file with 52 additions and 4 deletions.
diff --git a/doc/hurl.nvim.txt b/doc/hurl.nvim.txt
@@ -7,7 +7,7 @@ Table of Contents                                *hurl.nvim-table-of-contents*
   - Usage                                                    |hurl.nvim-usage|
   - Env File Support: vars.env          |hurl.nvim-env-file-support:-vars.env|
   - Default Key Mappings                      |hurl.nvim-default-key-mappings|
-  - Tips                                                      |hurl.nvim-tips|
+  - Configuration                                    |hurl.nvim-configuration|
   - Resources                                            |hurl.nvim-resources|
   - Credits                                                |hurl.nvim-credits|
   - Author                                                  |hurl.nvim-author|
@@ -110,10 +110,58 @@ These key mappings are active within the popup windows that `hurl.nvim`
 displays.
 
 
-TIPS                                                          *hurl.nvim-tips*
+CONFIGURATION                                        *hurl.nvim-configuration*
 
-Enable debug mode with `debug = true` for detailed logs. Logs are saved at
-`~/.cache/nvim/hurl.nvim.log` on macOS.
+`hurl.nvim` can be customized with the following default configurations:
+
+>lua
+    local default_config = {
+      -- Toggle debugging information
+      debug = false, -- If true, logs will be saved at ~/.cache/nvim/hurl.nvim.log
+
+      -- Set the display mode for the response: 'split' or 'popup'
+      mode = 'split',
+
+      -- Default environment file name
+      env_file = 'vars.env',
+
+      -- Specify formatters for different response types
+      formatters = {
+        json = { 'jq' },  -- Uses jq to format JSON responses
+        html = {
+          'prettier',     -- Uses prettier to format HTML responses
+          '--parser',
+          'html',
+        },
+      },
+    }
+<
+
+To apply these configurations, include them in your Neovim setup like this:
+
+>lua
+    require('hurl').setup({
+      debug = true,          -- Enable to show detailed logs
+      mode = 'popup',        -- Change to 'popup' to display responses in a popup window
+      env_file = 'vars.env', -- Change this to use a different environment file name
+      formatters = {
+        json = { 'jq' },    -- Customize the JSON formatter command
+        html = {
+          'prettier',       -- Customize the HTML formatter command
+          '--parser',
+          'html',
+        },
+      },
+    })
+<
+
+Adjust the settings as per your needs to enhance your development experience
+with `hurl.nvim`.
+
+
+TIPS ~
+
+Logs are saved at `~/.cache/nvim/hurl.nvim.log` on macOS.
 
 
 RESOURCES                                                *hurl.nvim-resources*