diff --git a/README.vim.md b/README.vim.md index 8a40507..85535d2 100644 --- a/README.vim.md +++ b/README.vim.md @@ -16,6 +16,33 @@ - **Rockspec**: [luarocks](https://luarocks.org/) `*-scm-1.rockspec` [file](https://github.com/luarocks/luarocks/wiki/Rockspec-format) - **Packspec**: `pkg.json` (experimental, since the [format](https://github.com/neovim/packspec/issues/41) is not quite there yet) + Related _lazy.nvim_ options: + + ```lua + { + pkg = { + enabled = true, + cache = vim.fn.stdpath("state") .. "/lazy/pkg-cache.lua", + -- the first package source that is found for a plugin will be used. + sources = { + "lazy", + "rockspec", + "packspec", + }, + }, + rocks = { + root = vim.fn.stdpath("data") .. "/lazy-rocks", + server = "https://nvim-neorocks.github.io/rocks-binaries/", + }, + } + ``` + +- Installing [neorg](https://github.com/nvim-neorg/neorg) is now as simple as: + + ```lua + { "nvim-neorg/neorg", opts = {} } + ``` + - Packages are not limited to just Neovim plugins. You can install any **luarocks** package, like: ```lua diff --git a/doc/lazy.nvim.txt b/doc/lazy.nvim.txt index a81b0f5..22e4d4b 100644 --- a/doc/lazy.nvim.txt +++ b/doc/lazy.nvim.txt @@ -59,6 +59,29 @@ Table of Contents *lazy.nvim-table-of-contents* - **Lazy**: `lazy.lua` file - **Rockspec**: luarocks `*-scm-1.rockspec` file - **Packspec**: `pkg.json` (experimental, since the format is not quite there yet) + Related _lazy.nvim_ options: + >lua + { + pkg = { + enabled = true, + cache = vim.fn.stdpath("state") .. "/lazy/pkg-cache.lua", + -- the first package source that is found for a plugin will be used. + sources = { + "lazy", + "rockspec", + "packspec", + }, + }, + rocks = { + root = vim.fn.stdpath("data") .. "/lazy-rocks", + server = "https://nvim-neorocks.github.io/rocks-binaries/", + }, + } + < +- Installing neorg is now as simple as: + >lua + { "nvim-neorg/neorg", opts = {} } + < - Packages are not limited to just Neovim plugins. You can install any **luarocks** package, like: >lua