chore: generate docs

doc/cutlass.nvim.txt

@@ -3,15 +3,17 @@
 ==============================================================================
 Table of Contents                             *cutlass.nvim-table-of-contents*
 
-1. cutlass.nvim                                    |cutlass.nvim-cutlass.nvim|
-  - Why would you want to do this?|cutlass.nvim-why-would-you-want-to-do-this?|
-  - Usage                                                 |cutlass.nvim-usage|
-  - Configuration                                 |cutlass.nvim-configuration|
-  - Integration                                     |cutlass.nvim-integration|
-  - Credits                                             |cutlass.nvim-credits|
+1. ✂️ cutlass.nvim                      |cutlass.nvim-✂️-cutlass.nvim|
+  - ✨ Features                                   |cutlass.nvim-✨-features|
+  - ❔ Why would you want to do this?|cutlass.nvim-❔-why-would-you-want-to-do-this?|
+  - ⚡️ Requirements                     |cutlass.nvim-⚡️-requirements|
+  - 📦 Installation                         |cutlass.nvim-📦-installation|
+  - ⚙️ Configuration                   |cutlass.nvim-⚙️-configuration|
+  - 🤝 Integration                           |cutlass.nvim-🤝-integration|
+  - 🎉 Credits                                   |cutlass.nvim-🎉-credits|
 
 ==============================================================================
-1. cutlass.nvim                                    *cutlass.nvim-cutlass.nvim*
+1. ✂️ cutlass.nvim                      *cutlass.nvim-✂️-cutlass.nvim*
 
 <img
 src='https://github.com/gbprod/cutlass.nvim/actions/workflows/integration.yml/badge.svg'
@@ -21,37 +23,75 @@ title=''/>
 Cutlass overrides the delete operations to actually just delete and not affect
 the current yank.
 
-It achieves this by overriding the following keys to always use the black hole
-register: `c`, `cc`, `C`, `s`, `S`, `d`, `dd`, `D`, `x`, `X`. Note that if you
-have already mapped these keys to something else (like we do below with `x`)
-then it will not change it again.
+✨ FEATURES                                       *cutlass.nvim-✨-features*
 
-WHY WOULD YOU WANT TO DO THIS?   *cutlass.nvim-why-would-you-want-to-do-this?*
+It overrides the following keys to always use the black hole register: `c`,
+`cc`, `C`, `s`, `S`, `d`, `dd`, `D`, `x`, `X`.
+
+Note that if you have already mapped these keys to something else (like we do
+below with `x`) then it will not change it again.
+
+❔ WHY WOULD YOU WANT TO DO THIS?*cutlass.nvim-❔-why-would-you-want-to-do-this?*
 
 See here
 <http://vimcasts.org/blog/2013/11/registers-the-good-the-bad-and-the-ugly-parts/>.
 This plugin already exists <https://github.com/svermeulen/vim-cutlass> in
 vimscript. I hope this version in lua will be more efficient :)
 
-USAGE                                                     *cutlass.nvim-usage*
+⚡️ REQUIREMENTS                         *cutlass.nvim-⚡️-requirements*
+
+
+- Neovim >= 0.5.0
 
-Requires neovim > 0.5.0.
 
-Using https://github.com/wbthomason/packer.nvim:
+📦 INSTALLATION                             *cutlass.nvim-📦-installation*
+
+Install the plugin with your preferred package manager:
+
+PACKER <HTTPS://GITHUB.COM/WBTHOMASON/PACKER.NVIM> ~
 
 >
+    -- Lua
     use({
       "gbprod/cutlass.nvim",
       config = function()
         require("cutlass").setup({
-            cut_key = "m"
+          -- your configuration comes here
+          -- or leave it empty to use the default settings
+          -- refer to the configuration section below
         })
       end
     })
 <
 
 
-CONFIGURATION                                     *cutlass.nvim-configuration*
+VIM-PLUG <HTTPS://GITHUB.COM/JUNEGUNN/VIM-PLUG> ~
+
+>
+    " Vim Script
+    Plug 'gbprod/cutlass.nvim'
+    lua << EOF
+      require("cutlass").setup({
+        -- your configuration comes here
+        -- or leave it empty to use the default settings
+        -- refer to the configuration section below
+      })
+    EOF
+<
+
+
+⚙️ CONFIGURATION                       *cutlass.nvim-⚙️-configuration*
+
+Cutlass comes with the following defaults:
+
+>
+    {
+      cut_key = nil,
+      override_del = nil,
+      exclude = {},
+    }
+<
+
 
 `CUT_KEY` ~
 
@@ -92,7 +132,7 @@ Eg. If you want to exclude `s` key in normal mode, sets `exclude` option to `{
 "ns" }` ; If you want to exclude `<bs>` key in select mode, sets `exclude`
 option to `{ "s<bs>" }`.
 
-INTEGRATION                                         *cutlass.nvim-integration*
+🤝 INTEGRATION                               *cutlass.nvim-🤝-integration*
 
 svermeulen/vim-yoink ~
 
@@ -120,7 +160,7 @@ remap the `s` key. You can do this using the `exclude` option:
 <
 
 
-CREDITS                                                 *cutlass.nvim-credits*
+🎉 CREDITS                                       *cutlass.nvim-🎉-credits*
 
 This plugin is a lua version of svermeulen/vim-cutlass
 <https://github.com/svermeulen/vim-cutlass> (based off of vim-easyclip