jank/lazy.nvim
1
0
Fork 0
mirror of https://github.com/folke/lazy.nvim.git synced 2025-06-28 11:24:14 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: add file tree to plugin structuring section

Browse source
This commit is contained in:
pseudometa 2022-12-28 15:02:48 +01:00
commit 44bd7f25a1
1 changed files with 39 additions and 23 deletions
Download patch file Download diff file Expand all files Collapse all files

62
README.md
View file

@ -6,29 +6,29 @@
## Table of Contents ## Table of Contents
<!-- vim-markdown-toc GFM --> <!-- vim-markdown-toc GFM -->
* [✨ Features](#-features) - [✨ Features](#-features)
* [⚡️ Requirements](#%EF%B8%8F-requirements) - [⚡️ Requirements](#%EF%B8%8F-requirements)
* [📦 Installation](#-installation) - [📦 Installation](#-installation)
* [🔌 Plugin Spec](#-plugin-spec) - [🔌 Plugin Spec](#-plugin-spec)
* [Lazy Loading](#lazy-loading) - [Lazy Loading](#lazy-loading)
* [🌈 Colorschemes](#-colorschemes) - [🌈 Colorschemes](#-colorschemes)
* [⌨️ Lazy Key Mappings](#%EF%B8%8F-lazy-key-mappings) - [⌨️ Lazy Key Mappings](#%EF%B8%8F-lazy-key-mappings)
* [Versioning](#versioning) - [Versioning](#versioning)
* [Examples](#examples) - [Examples](#examples)
* [⚙️ Configuration](#%EF%B8%8F-configuration) - [⚙️ Configuration](#%EF%B8%8F-configuration)
* [🚀 Usage](#-usage) - [🚀 Usage](#-usage)
* [📆 User Events](#-user-events) - [📆 User Events](#-user-events)
* [🔒 Lockfile `lazy-lock.json`](#-lockfile-lazy-lockjson) - [🔒 Lockfile `lazy-lock.json`](#-lockfile-lazy-lockjson)
* [⚡ Performance](#-performance) - [⚡ Performance](#-performance)
* [🪲 Debug](#-debug) - [🪲 Debug](#-debug)
* [▶️ Startup Sequence](#%EF%B8%8F-startup-sequence) - [▶️ Startup Sequence](#%EF%B8%8F-startup-sequence)
* [📂 Structuring Your Plugins](#-structuring-your-plugins) - [📂 Structuring Your Plugins](#-structuring-your-plugins)
* [📦 Migration Guide](#-migration-guide) - [📦 Migration Guide](#-migration-guide)
* [packer.nvim](#packernvim) - [packer.nvim](#packernvim)
* [paq-nvim](#paq-nvim) - [paq-nvim](#paq-nvim)
* [❌ Uninstalling](#-uninstalling) - [❌ Uninstalling](#-uninstalling)
* [🌈 Highlight Groups](#-highlight-groups) - [🌈 Highlight Groups](#-highlight-groups)
* [📦 Other Neovim Plugin Managers in Lua](#-other-neovim-plugin-managers-in-lua) - [📦 Other Neovim Plugin Managers in Lua](#-other-neovim-plugin-managers-in-lua)
<!-- vim-markdown-toc --> <!-- vim-markdown-toc -->
@ -679,6 +679,22 @@ return {
- any lua file in `~/.config/nvim/lua/plugins/*.lua` will be automatically merged in the main plugin spec - any lua file in `~/.config/nvim/lua/plugins/*.lua` will be automatically merged in the main plugin spec
```bash
.
├── init.lua # <- requiring config.lazy
├── lazy-lock.json
├── lua
│ └── config
│ ├── …
│ ├── lazy.lua # <- bootstrap & setup lazy.nvim
│ ├── plugins
│ │ ├── init.lua # <- config.plugins: main plugin config module
│ │ ├── … # <- submodules automatically merged in the main spec
│ │ └── …
│ └── …
└─── …
```
For a real-life example, you can check my personal dots: For a real-life example, you can check my personal dots:
- [init.lua](https://github.com/folke/dot/blob/master/config/nvim/init.lua) where I require `config.lazy` - [init.lua](https://github.com/folke/dot/blob/master/config/nvim/init.lua) where I require `config.lazy`