aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorgithub-actions[bot] <github-actions[bot]@users.noreply.github.com>2023-02-15 16:01:14 +0000
committergithub-actions[bot] <github-actions[bot]@users.noreply.github.com>2023-02-15 16:01:14 +0000
commit3c24b918a95f36849092c3a8d1001b5390fe191c (patch)
treeb8297b70dbb94d0294a1892eb67d358ab64b0a69 /doc
parentdocs(readme): update installation instructions (diff)
docs(help): auto generate docs
Diffstat (limited to 'doc')
-rw-r--r--doc/pets.nvim.txt22
1 files changed, 13 insertions, 9 deletions
diff --git a/doc/pets.nvim.txt b/doc/pets.nvim.txt
index 20c9e69..9a36682 100644
--- a/doc/pets.nvim.txt
+++ b/doc/pets.nvim.txt
@@ -38,11 +38,6 @@ With packer:
>
use({
"giusgad/pets.nvim",
- config = function()
- require("pets").setup({
- -- your options
- })
- end,
requires = {
"edluffy/hologram.nvim",
"MunifTanjim/nui.nvim",
@@ -61,6 +56,15 @@ With lazy:
<
+And then call
+
+>
+ require("pets").setup({
+ -- your options here
+ })
+<
+
+
⚙️ CONFIGURATION *pets.nvim-⚙️-configuration*
This is the default configuration:
@@ -97,10 +101,10 @@ the style and type defined by the configuration, and name {name} -
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. - `PetsPauseToggle`: pause/resume animations for
-all pets, leaving them on screen as cute little statues - `PetsHideToggle`:
-pause the animation for all pets and hide them / show all the pets again and
-resume animations
+all the pets, poor creatures. Works just as PetsKill but for every pet. -
+`PetsPauseToggle`: pause/resume animations for all pets, leaving them on screen
+as cute little statues - `PetsHideToggle`: pause the animation for all pets and
+hide them / show all the pets again and resume animations
⚠️ LIMITATIONS *pets.nvim-⚠️-limitations*