feat(help): allow disabling README magic (#663)

folke · Mar 17, 2023 · e5759d2 · e5759d2
1 parent b3eca0c
commit e5759d2
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -435,6 +435,7 @@ return {
   -- 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 = {
+    enabled = true,
     root = vim.fn.stdpath("state") .. "/lazy/readme",
     files = { "README.md", "lua/**/README.md" },
     -- only generate markdown helptags for plugins that dont have docs

diff --git a/lua/lazy/core/config.lua b/lua/lazy/core/config.lua
@@ -141,6 +141,7 @@ M.defaults = {
   -- 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 = {
+    enabled = true,
     root = vim.fn.stdpath("state") .. "/lazy/readme",
     files = { "README.md", "lua/**/README.md" },
     -- only generate markdown helptags for plugins that dont have docs

diff --git a/lua/lazy/help.lua b/lua/lazy/help.lua
@@ -41,6 +41,10 @@ function M.update()
   if Config.plugins["lazy.nvim"] then
     vim.cmd.helptags(Config.plugins["lazy.nvim"].dir .. "/doc")
   end
+  if Config.options.readme.enabled == false then
+    return
+  end
+
   local docs = Config.options.readme.root .. "/doc"
   vim.fn.mkdir(docs, "p")