docs(help): auto generate docs

1 files changed, 35 insertions, 17 deletions

diff --git a/doc/pets.nvim.txt b/doc/pets.nvim.txt
index 3209f6f..3c96cf9 100644
--- a/doc/pets.nvim.txt
+++ b/doc/pets.nvim.txt
@@ -4,8 +4,12 @@
 Table of Contents                                *pets.nvim-table-of-contents*
 
 1. pets.nvim                                             |pets.nvim-pets.nvim|
+  - 📦 Installation                            |pets.nvim-📦-installation|
   - ⚙️ Configuration                      |pets.nvim-⚙️-configuration|
   - 🐾 Available pets                        |pets.nvim-🐾-available-pets|
+  - 📑 Usage - commands                    |pets.nvim-📑-usage---commands|
+  - ⚠️ Limitations                          |pets.nvim-⚠️-limitations|
+  - 👏 Credits                                      |pets.nvim-👏-credits|
 
 ==============================================================================
 1. pets.nvim                                             *pets.nvim-pets.nvim*
@@ -15,8 +19,13 @@ little animal friends inside your editor. It relies on the kitty graphics
 protocol <https://sw.kovidgoyal.net/kitty/graphics-protocol/> and hologram.nvim
 <https://github.com/edluffy/hologram.nvim> to be able to display images in a
 terminal window. As you might know the plugin is heavily inspired by
-vscode-pets <https://github.com/tonybaloney/vscode-pets/tree/master/media> ##
-📦 Installation Install with your favorite package manager! Examples:
+vscode-pets <https://github.com/tonybaloney/vscode-pets/tree/master/media>
+
+📦 INSTALLATION                                *pets.nvim-📦-installation*
+
+Install with your favorite package manager!
+
+Examples:
 
 With packer:
 
@@ -75,23 +84,32 @@ This is the default configuration:
     - brown
     - dark_grey
     - light_grey
-        ## 📑 Usage - commands
-        These are all the available commands:
-- `PetsNew {name}`: creates a pet with the style and type defined by the configuration, and name {name}
-- `PetsNewCustom {type} {style} {name}`: creates a new pet with type, style and name specified in the command
-- `PetsList`: prints the names of all the pets that are currently alive
-- `PetsKill {name}`: kills the pet with given name, which will immediately blink out of existence. Forever.
-- `PetsKillAll`: kills all the pets, poor creatures.
-    ## ⚠️ Limitations
-    This plugin relies on hologram.nvim <https://github.com/edluffy/hologram.nvim> to display the images,
-    and shares all of its limitations. Here are the most significant ones:
-- Only works with terminal emulators that support the kitty graphics protocol <https://sw.kovidgoyal.net/kitty/graphics-protocol/>
-    To be more precise the only terminal I tested where I was able to have the protocol working correctly is kitty itself.
-- Doesn’t currently work inside tmux
-    ## 👏 Credits
-    All the beautiful cat assets were designed by SeethingSwarm <https://seethingswarm.itch.io/catset>
 
 
+📑 USAGE - COMMANDS                        *pets.nvim-📑-usage---commands*
+
+These are all the available commands: - `PetsNew {name}`: creates a pet with
+the style and type defined by the configuration, and name {name} -
+`PetsNewCustom {type} {style} {name}`: creates a new pet with type, style and
+name specified in the command - `PetsList`: prints the names of all the pets
+that are currently alive - `PetsKill {name}`: kills the pet with given name,
+which will immediately blink out of existence. Forever. - `PetsKillAll`: kills
+all the pets, poor creatures.
+
+⚠️ LIMITATIONS                              *pets.nvim-⚠️-limitations*
+
+This plugin relies on hologram.nvim <https://github.com/edluffy/hologram.nvim>
+to display the images, and shares all of its limitations. Here are the most
+significant ones: - Only works with terminal emulators that support the kitty
+graphics protocol <https://sw.kovidgoyal.net/kitty/graphics-protocol/> To be
+more precise the only terminal I tested where I was able to have the protocol
+working correctly is kitty itself. - Doesn’t currently work inside tmux
+
+👏 CREDITS                                          *pets.nvim-👏-credits*
+
+All the beautiful cat assets were designed by SeethingSwarm
+<https://seethingswarm.itch.io/catset>
+
 Generated by panvimdoc <https://github.com/kdheepak/panvimdoc>
 
 vim:tw=78:ts=8:noet:ft=help:norl: