subcrip
/
lazy.nvim
mirror of https://github.com/folke/lazy.nvim.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: added docs on readme help indexing

This commit is contained in:
Folke Lemaitre 2022-12-15 14:34:08 +01:00
parent 4dfab59c87
commit fd600be2e5
No known key found for this signature in database
GPG Key ID: 41F8B1FBACAE2040
2 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
README.md
View File

@ -15,6 +15,7 @@
- 🛠️ No need to manually compile plugins - 🛠️ No need to manually compile plugins
- 🧪 Correct sequencing of dependencies - 🧪 Correct sequencing of dependencies
- 📁 Configurable in multiple files - 📁 Configurable in multiple files
- 📚 Generates helptags of the headings in `README.md` files for plugins that don't have vimdocs
- 💻 Dev options and patterns for using local plugins - 💻 Dev options and patterns for using local plugins
- 📊 Profiling tools to optimize performance - 📊 Profiling tools to optimize performance
- 🔒 Lockfile `lazy-lock.json` to keep track of installed plugins - 🔒 Lockfile `lazy-lock.json` to keep track of installed plugins

4
lua/lazy/core/config.lua
View File

@ -75,9 +75,13 @@ M.defaults = {
}, },
}, },
}, },
-- 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 = { readme = {
root = vim.fn.stdpath("state") .. "/lazy/readme", root = vim.fn.stdpath("state") .. "/lazy/readme",
files = { "README.md" }, files = { "README.md" },
-- only generate markdown helptags for plugins that dont have docs
skip_if_doc_exists = true, skip_if_doc_exists = true,
}, },
debug = false, debug = false,