docs: updated config

This commit is contained in:
Folke Lemaitre 2022-12-15 14:43:47 +01:00
parent 9f0a02fb0f
commit 57dfb05e2f
No known key found for this signature in database
GPG Key ID: 41F8B1FBACAE2040
1 changed files with 17 additions and 8 deletions

View File

@ -28,14 +28,14 @@
<!-- toc:start -->
- [⚡️ Requirements](#-requirements)
- [📦 Installation](#-installation)
- [🔌 Plugin Spec](#-plugin-spec)
- [⚙️ Configuration](#-configuration)
- [🚀 Usage](#-usage)
- [📊 Profiler](#-profiler)
- [🪲 Debug](#-debug)
- [📦 Differences with Packer](#-differences-with-packer)
- [📦 Other Neovim Plugin Managers in Lua](#-other-neovim-plugin-managers-in-lua)
- [📦 Installation](#-installation)
- [🔌 Plugin Spec](#-plugin-spec)
- [⚙️ Configuration](#-configuration)
- [🚀 Usage](#-usage)
- [📊 Profiler](#-profiler)
- [🪲 Debug](#-debug)
- [📦 Differences with Packer](#-differences-with-packer)
- [📦 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,
},
}
```