chore(doc): auto generate docs

jellydn · Nov 12, 2024 · 742ecaf · 742ecaf
1 parent 1137aec
commit 742ecaf
Showing 1 changed file with 15 additions and 18 deletions.
diff --git a/doc/hurl.nvim.txt b/doc/hurl.nvim.txt
@@ -1,4 +1,4 @@
-*hurl.nvim.txt*          For NVIM v0.8.0          Last change: 2024 October 29
+*hurl.nvim.txt*          For NVIM v0.8.0         Last change: 2024 November 12
 
 ==============================================================================
 Table of Contents                                *hurl.nvim-table-of-contents*
@@ -63,8 +63,16 @@ Add the following configuration to your Neovim setup with lazy.nvim
       dependencies = {
           "MunifTanjim/nui.nvim",
           "nvim-lua/plenary.nvim",
-          "nvim-treesitter/nvim-treesitter"
-      },
+          "nvim-treesitter/nvim-treesitter",
+          -- Optional, for markdown rendering with render-markdown.nvim
+          {
+            'MeanderingProgrammer/render-markdown.nvim',
+            opts = {
+              file_types = { "markdown" },
+            },
+            ft = { "markdown" },
+          },
+      }
       ft = "hurl",
       opts = {
         -- Show debugging info
@@ -103,6 +111,7 @@ Add the following configuration to your Neovim setup with lazy.nvim
         { "<leader>tE", "<cmd>HurlRunnerToEnd<CR>", desc = "Run Api request from current entry to end" },
         { "<leader>tm", "<cmd>HurlToggleMode<CR>", desc = "Hurl Toggle Mode" },
         { "<leader>tv", "<cmd>HurlVerbose<CR>", desc = "Run Api in verbose mode" },
+        { "<leader>tV", "<cmd>HurlVeryVerbose<CR>", desc = "Run Api in very verbose mode" },
         -- Run Hurl request in visual mode
         { "<leader>h", ":HurlRunner<CR>", desc = "Hurl Runner", mode = "v" },
       },
@@ -272,11 +281,9 @@ command to execute the entry request.
 
 VERBOSE MODE
 
-Run `HurlVerbose` command to execute the request in verbose mode. The response
-will be displayed in QuickFix window. This is useful for debugging purposes or
-getting the curl command from hurl file.
+Run `HurlVerbose` command to execute the request in verbose mode.
 
-<https://gyazo.com/7d0f709e2db53f8c9e05655347f11bc9>
+<https://gyazo.com/6136ea63c0a3d0e1293e1fd2c724973a>
 
 
 RUN TO ENTRY ~
@@ -458,16 +465,6 @@ TIPS ~
 - Logs are saved at `~/.local/state/nvim/hurl.nvim.log` on macOS.
 
 
-  [!TIP] Split mode with Edgy
-- `hurl.nvim` can be used with edgy.nvim <https://github.com/folke/edgy.nvim> to manage layout when using the split mode.
-
->lua
-    right = {
-      { title = "Hurl Nvim", size = { width = 0.5 }, ft = "hurl-nvim" },
-    }
-<
-
-
   [!TIP] Syntax Highlighting in Stable Neovim
 - If you’re using a stable version of Neovim that doesn’t support Hurl syntax highlighting, you can set the filetype to `sh` or `bash` for your `.hurl` files. This will enable basic syntax highlighting that can improve readability. To do this, add the following line to your Neovim configuration:
 
@@ -534,7 +531,7 @@ Contributions of any kind welcome!
 4. *Run a file in popup mode*: https://i.gyazo.com/e554e81788aad910848ff991c9369d7b.gif
 5. *Run a selection in popup mode*: https://i.gyazo.com/1a44dbbf165006fb5744c8f10883bb69.gif
 6. *Run at current line in popup mode*: https://i.gyazo.com/20efd2cf3f73238bd57e79fc662208b1.gif
-7. *Run at current line in verbose mode*: https://i.gyazo.com/7d0f709e2db53f8c9e05655347f11bc9.gif
+7. *Run in verbose mode*: https://i.gyazo.com/6136ea63c0a3d0e1293e1fd2c724973a.gif
 8. *Run to entry in split mode*: https://i.gyazo.com/14d47adbfcab9e945f89e020b83328a9.gif
 9. *Toggle mode*: https://i.gyazo.com/b36b19ab76524b95015eafe4c6e1c81f.gif
 10. *Manage variables*: https://i.gyazo.com/0492719eb7a14f42cebff6996bde8672.gif