chore(docs): Auto generate docs

Author: rokbot

doc/code_runner.txt

@@ -3,22 +3,30 @@
 ==============================================================================
 Table of Contents                              *code_runner-table-of-contents*
 
-  - Introduction                                    |code_runner-introduction|
-  - Requirements                                    |code_runner-requirements|
-  - Install                                              |code_runner-install|
-  - Features                                            |code_runner-features|
-  - Setup                                                  |code_runner-setup|
-  - Commands                                            |code_runner-commands|
-  - Parameters                                        |code_runner-parameters|
-  - Hooks                                                  |code_runner-hooks|
-  - Integration with other plugins|code_runner-integration-with-other-plugins|
-  - Inspirations and thanks              |code_runner-inspirations-and-thanks|
-  - Screenshots                                      |code_runner-screenshots|
-  - Contributing                                    |code_runner-contributing|
-1. LICENCE                                               |code_runner-licence|
-2. Links                                                   |code_runner-links|
-Code_Runner  Code Runner for Neovim written in pure lua 󰢱
-INTRODUCTION                                        *code_runner-introduction*
+1. code_runner.nvim                             |code_runner-code_runner.nvim|
+  - Introduction                   |code_runner-code_runner.nvim-introduction|
+  - Requirements                   |code_runner-code_runner.nvim-requirements|
+  - Install                             |code_runner-code_runner.nvim-install|
+  - Features                           |code_runner-code_runner.nvim-features|
+  - Setup                                 |code_runner-code_runner.nvim-setup|
+  - Commands                           |code_runner-code_runner.nvim-commands|
+  - Parameters                       |code_runner-code_runner.nvim-parameters|
+  - Hooks                                 |code_runner-code_runner.nvim-hooks|
+  - Integration with other plugins|code_runner-code_runner.nvim-integration-with-other-plugins|
+  - Inspirations and thanks|code_runner-code_runner.nvim-inspirations-and-thanks|
+  - Screenshots                     |code_runner-code_runner.nvim-screenshots|
+  - Contributing                   |code_runner-code_runner.nvim-contributing|
+  - Similar Projects           |code_runner-code_runner.nvim-similar-projects|
+2. LICENCE                                               |code_runner-licence|
+3. Links                                                   |code_runner-links|
+
+==============================================================================
+1. code_runner.nvim                             *code_runner-code_runner.nvim*
+
+🏃‍♂️ Code Runner for Neovim written in pure lua 🌙
+
+
+INTRODUCTION                       *code_runner-code_runner.nvim-introduction*
 
 When I was still in college it was common to try multiple programming
 languages, at that time I used vscode that with a single plugin allowed me to
@@ -33,18 +41,18 @@ Currently I don’t test many languages anymore and work in the professional
 environment, but this plugin is still my swiss army knife.
 
 
-REQUIREMENTS                                        *code_runner-requirements*
+REQUIREMENTS                       *code_runner-code_runner.nvim-requirements*
 
 - Neovim (>= 0.10)
 
 
-INSTALL                                                  *code_runner-install*
+INSTALL                                 *code_runner-code_runner.nvim-install*
 
 - With lazy.nvim <https://github.com/folke/lazy.nvim>
 
 >lua
     require("lazy").setup({
-      { "CRAG666/code_runner.nvim", 
+      { "CRAG666/code_runner.nvim",
          event= "VeryLazy",
       },
     }
@@ -66,7 +74,7 @@ Please see my config code_runner.lua
 <https://github.com/CRAG666/dotfiles/blob/main/config/nvim/lua/plugins/dev/code_runner.lua>
 
 
-FEATURES                                                *code_runner-features*
+FEATURES                               *code_runner-code_runner.nvim-features*
 
 
   **Note** If you want implement a new feature open an issue to know if it is
@@ -83,11 +91,11 @@ FEATURES                                                *code_runner-features*
 - Run project commands in different modes for a per projects base
 
 
-SETUP                                                      *code_runner-setup*
+SETUP                                     *code_runner-code_runner.nvim-setup*
 
 This plugin can be configured either in lua, with the `setup` function, or with
-json files for interopability between this plugin and the original code runner
-<https://github.com/formulahendry/vscode-code-runner> vscode plugin.
+json files for interoperability between this plugin and the original code
+runner <https://github.com/formulahendry/vscode-code-runner> vscode plugin.
 
 
 MINIMAL EXAMPLE ~
@@ -150,7 +158,7 @@ JSON
 <
 
 
-COMMANDS                                                *code_runner-commands*
+COMMANDS                               *code_runner-code_runner.nvim-commands*
 
 
   **Note** To check what modes ore supported see |code_runner-mode-parameter|.
@@ -177,7 +185,7 @@ Recommended mappings:
 <
 
 
-PARAMETERS                                            *code_runner-parameters*
+PARAMETERS                           *code_runner-code_runner.nvim-parameters*
 
 
 SETUP GLOBAL ~
@@ -188,10 +196,14 @@ see the default values see: `code_runner.nvim/lua/code_runner/options`
 
 Parameters:
 
-- `mode`: Display Mode in which you want to run. Supported: "term", "float", "tab","better_term", "toggleterm" (type: `string`, default: "term")
-- `focus`: Focus on runner window. Only works on "term" and "tab" display modes (type: `bool`, default: false)
-- `startinsert`: init in insert mode. Only works on "term" and "tab" display modes (type: `bool`, default: false)
-- `hot_reload`: Run automatically on buffer save, only works in "term" or similar (type: `bool`, default: true)
+- `mode`: Display Mode in which you want to run. Supported: "term", "float",
+    "tab","better_term", "toggleterm" (type: `string`, default: "term")
+- `focus`: Focus on runner window. Only works on "term" and "tab" display modes
+    (type: `bool`, default: false)
+- `startinsert`: init in insert mode. Only works on "term" and "tab" display
+    modes (type: `bool`, default: false)
+- `hot_reload`: Run automatically on buffer save, only works in "term" or similar
+    (type: `bool`, default: true)
 - `term`: Configurations for the integrated terminal (type: `table`)
     - `position`: terminal position consult |windows| for options (type: `string`)
     - `size`: Size of the terminal window (type: `uint` | `float`)
@@ -208,15 +220,18 @@ Parameters:
     - `x`: (type: `float`)
     - `y`: (type: `float`)
     - `border_hl`: (type: `string`)
-- `better_term`: Toggle mode replacement(Install CRAG666/betterTerm.nvim <https://github.com/CRAG666/betterTerm.nvim>)
+- `better_term`: Toggle mode replacement(Install CRAG666/betterTerm.nvim
+    <https://github.com/CRAG666/betterTerm.nvim>)
     - `clean`: Clean terminal before launch(type: `bool`)
     - `number`: Use nil for dynamic number and set init(type: `uint?`)
     - `init`: Set a start number for executions, each execution will go to a different terminal(type: `uint?`)
         },
 - `before_run_filetype`: Execute before executing a file (type: `func`)
-- `filetype`: If you prefer to use lua instead of json files, you can add your settings by file type here (type: `table`)
+- `filetype`: If you prefer to use lua instead of json files, you can add your
+    settings by file type here (type: `table`)
 - `filetype_path`: Absolute path to json file config (type: `absolute paths`)
-- `project`: If you prefer to use lua instead of json files, you can add your settings by project here (type: `table`)
+- `project`: If you prefer to use lua instead of json files, you can add your
+    settings by project here (type: `table`)
 - `project_path`: Absolute path to json file config (type: `absolute paths`)
 
 
@@ -248,7 +263,7 @@ The filetype table can take either a `string`, a `table` or a `function`.
 <
 
 If you want to add some other language or some other command follow this
-structure `key = commans`.
+structure `key = commands`.
 
 
 JSON
@@ -379,7 +394,7 @@ PARAMETERS
   **Note** Don’t forget to name your projects because if you don’t do so code
   runner will fail as it uses the name for the buffer name
 
-HOOKS                                                      *code_runner-hooks*
+HOOKS                                     *code_runner-code_runner.nvim-hooks*
 
 These elements are intended to help with those commands that require more
 complexity. For example, implement hot reload on markup documents.
@@ -540,7 +555,7 @@ a new vertical windows and reload on save. Read the comments for more info.
 <
 
 
-INTEGRATION WITH OTHER PLUGINS    *code_runner-integration-with-other-plugins*
+INTEGRATION WITH OTHER PLUGINS*code_runner-code_runner.nvim-integration-with-other-plugins*
 
 
 API ~
@@ -567,7 +582,7 @@ how to use harpoon term together with code_runner.nvim:
 <
 
 
-INSPIRATIONS AND THANKS                  *code_runner-inspirations-and-thanks*
+INSPIRATIONS AND THANKS *code_runner-code_runner.nvim-inspirations-and-thanks*
 
 - The idea of this project comes from the vscode plugin code_runner <https://marketplace.visualstudio.com/items?itemName=formulahendry.code-runner> You can even copy your configuration and pass it to this plugin, as they are the same in the way of defining commands associated with filetypes <https://github.com/CRAG666/code_runner.nvim#add-support-for-more-file-types>
 - jaq-nvim <https://github.com/is0n/jaq-nvim> some ideas of how to execute commands were taken from this plugin, thank you very much.
@@ -578,10 +593,10 @@ INSPIRATIONS AND THANKS                  *code_runner-inspirations-and-thanks*
 - Thanks to all current and future collaborators, without their contributions this plugin would not be what it is today
 
 
-SCREENSHOTS                                          *code_runner-screenshots*
+SCREENSHOTS                         *code_runner-code_runner.nvim-screenshots*
 
 
-CONTRIBUTING                                        *code_runner-contributing*
+CONTRIBUTING                       *code_runner-code_runner.nvim-contributing*
 
 
   **Note** If you have any ideas to improve this project, do not hesitate to make
@@ -592,14 +607,19 @@ contribute, criticize (don’t be soft) or contribute ideas. All PRs are
 welcome.
 
 
+SIMILAR PROJECTS               *code_runner-code_runner.nvim-similar-projects*
+
+- SnipRun <https://github.com/michaelb/sniprun>
+- iron.nvim <https://github.com/Vigemus/iron.nvim>
+
+
 ==============================================================================
-1. LICENCE                                               *code_runner-licence*
+2. LICENCE                                               *code_runner-licence*
 
-------------------------------------------------------------------------------
 MIT <https://github.com/CRAG666/code_runner.nvim/blob/main/LICENSE>
 
 ==============================================================================
-2. Links                                                   *code_runner-links*
+3. Links                                                   *code_runner-links*
 
 1. *preview*: https://github.com/CRAG666/dotfiles/blob/main/config/nvim/lua/plugins/dev/code_runner.lua
 2. *@adalessa*: