chore(doc): auto generate docs

jellydn · Oct 31, 2023 · d020cb4 · d020cb4
1 parent 95c670d
commit d020cb4
Showing 1 changed file with 23 additions and 6 deletions.
diff --git a/doc/hurl.nvim.txt b/doc/hurl.nvim.txt
@@ -7,6 +7,7 @@ Table of Contents                                *hurl.nvim-table-of-contents*
   - Usage                                                    |hurl.nvim-usage|
   - Demo                                                      |hurl.nvim-demo|
   - Default Key Mappings                      |hurl.nvim-default-key-mappings|
+  - Tips                                                      |hurl.nvim-tips|
   - Credits                                                |hurl.nvim-credits|
   - Author                                                  |hurl.nvim-author|
   - Show your support                            |hurl.nvim-show-your-support|
@@ -35,8 +36,8 @@ Add the following configuration to your Neovim setup:
         },
         keys = {
           -- Run API request
-          { "<leader>rA", "<cmd>HurlRunner<CR>", desc = "Run All requests" },
-          { "<leader>ra", "<cmd>HurlRunnerAt<CR>", desc = "Run Api request" },
+          { "<leader>A", "<cmd>HurlRunner<CR>", desc = "Run All requests" },
+          { "<leader>a", "<cmd>HurlRunnerAt<CR>", desc = "Run Api request" },
           -- Run Hurl request in visual mode
           { "<leader>h", ":HurlRunner<CR>", desc = "Hurl Runner", mode = "v" },
         },
@@ -64,6 +65,13 @@ Click on the GIF below to view the full demo:
 <https://gyazo.com/1a44dbbf165006fb5744c8f10883bb69>
 
 
+RUN AT CURRENT LINE ~
+
+Click on the GIF below to view the full demo:
+
+<https://gyazo.com/20efd2cf3f73238bd57e79fc662208b1>
+
+
 DEFAULT KEY MAPPINGS                          *hurl.nvim-default-key-mappings*
 
 `hurl.nvim` comes with some default key mappings to streamline your workflow:
@@ -76,6 +84,14 @@ These key mappings are active within the popup windows that `hurl.nvim`
 displays.
 
 
+TIPS                                                          *hurl.nvim-tips*
+
+You could enable debug mode with `debug = true` in your configuration to see
+more information. All the logs will be printed in the `hurl.nvim.log` in Neovim
+cache folder. For instance, in MacOS, the log file is located at
+`~/.cache/nvim/hurl.nvim.log`.
+
+
 CREDITS                                                    *hurl.nvim-credits*
 
 - Hurl - Run and Test HTTP Requests <https://hurl.dev/>
@@ -104,11 +120,12 @@ If this guide has been helpful, please give it a ⭐️.
 
 1. *Run a file*: https://i.gyazo.com/e554e81788aad910848ff991c9369d7b.gif
 2. *Selection*: https://i.gyazo.com/1a44dbbf165006fb5744c8f10883bb69.gif
-3. *@jellydn*: 
+3. *Run at current line*: https://i.gyazo.com/20efd2cf3f73238bd57e79fc662208b1.gif
 4. *@jellydn*: 
-5. *kofi*: https://img.shields.io/badge/Ko--fi-F16061?style=for-the-badge&logo=ko-fi&logoColor=white
-6. *paypal*: https://img.shields.io/badge/PayPal-00457C?style=for-the-badge&logo=paypal&logoColor=white
-7. *buymeacoffee*: https://img.shields.io/badge/Buy_Me_A_Coffee-FFDD00?style=for-the-badge&logo=buy-me-a-coffee&logoColor=black
+5. *@jellydn*: 
+6. *kofi*: https://img.shields.io/badge/Ko--fi-F16061?style=for-the-badge&logo=ko-fi&logoColor=white
+7. *paypal*: https://img.shields.io/badge/PayPal-00457C?style=for-the-badge&logo=paypal&logoColor=white
+8. *buymeacoffee*: https://img.shields.io/badge/Buy_Me_A_Coffee-FFDD00?style=for-the-badge&logo=buy-me-a-coffee&logoColor=black
 
 Generated by panvimdoc <https://github.com/kdheepak/panvimdoc>