docs: updated config

README.md

@@ -28,14 +28,14 @@
 <!-- toc:start -->
 
 - [⚡️ Requirements](#-requirements)
-- [📦 Installation](#-installation)
+ - [📦 Installation](#-installation)
-- [🔌 Plugin Spec](#-plugin-spec)
+ - [🔌 Plugin Spec](#-plugin-spec)
-- [⚙️ Configuration](#-configuration)
+ - [⚙️ Configuration](#-configuration)
-- [🚀 Usage](#-usage)
+ - [🚀 Usage](#-usage)
-- [📊 Profiler](#-profiler)
+ - [📊 Profiler](#-profiler)
-- [🪲 Debug](#-debug)
+ - [🪲 Debug](#-debug)
-- [📦 Differences with Packer](#-differences-with-packer)
+ - [📦 Differences with Packer](#-differences-with-packer)
-- [📦 Other Neovim Plugin Managers in Lua](#-other-neovim-plugin-managers-in-lua)
+ - [📦 Other Neovim Plugin Managers in Lua](#-other-neovim-plugin-managers-in-lua)
 
 <!-- toc:end -->
 
@@ -277,6 +277,15 @@ return {
       },
     },
   },
+  -- lazy can generate helptags from the headings in markdown readme files,
+  -- so :help works even for plugins that don't have vim docs.
+  -- when the readme opens with :help it will be correctly displayed as markdown
+  readme = {
+    root = vim.fn.stdpath("state") .. "/lazy/readme",
+    files = { "README.md" },
+    -- only generate markdown helptags for plugins that dont have docs
+    skip_if_doc_exists = true,
+  },
 }
 ```