mirror of
https://github.com/folke/lazy.nvim.git
synced 2025-06-28 19:34:15 +00:00
docs: add file tree to plugin structuring section
This commit is contained in:
parent
8ee9fc9cab
commit
44bd7f25a1
1 changed files with 39 additions and 23 deletions
62
README.md
62
README.md
|
@ -6,29 +6,29 @@
|
|||
|
||||
## Table of Contents
|
||||
<!-- vim-markdown-toc GFM -->
|
||||
* [✨ Features](#-features)
|
||||
* [⚡️ Requirements](#%EF%B8%8F-requirements)
|
||||
* [📦 Installation](#-installation)
|
||||
* [🔌 Plugin Spec](#-plugin-spec)
|
||||
* [Lazy Loading](#lazy-loading)
|
||||
* [🌈 Colorschemes](#-colorschemes)
|
||||
* [⌨️ Lazy Key Mappings](#%EF%B8%8F-lazy-key-mappings)
|
||||
* [Versioning](#versioning)
|
||||
* [Examples](#examples)
|
||||
* [⚙️ Configuration](#%EF%B8%8F-configuration)
|
||||
* [🚀 Usage](#-usage)
|
||||
* [📆 User Events](#-user-events)
|
||||
* [🔒 Lockfile `lazy-lock.json`](#-lockfile-lazy-lockjson)
|
||||
* [⚡ Performance](#-performance)
|
||||
* [🪲 Debug](#-debug)
|
||||
* [▶️ Startup Sequence](#%EF%B8%8F-startup-sequence)
|
||||
* [📂 Structuring Your Plugins](#-structuring-your-plugins)
|
||||
* [📦 Migration Guide](#-migration-guide)
|
||||
* [packer.nvim](#packernvim)
|
||||
* [paq-nvim](#paq-nvim)
|
||||
* [❌ Uninstalling](#-uninstalling)
|
||||
* [🌈 Highlight Groups](#-highlight-groups)
|
||||
* [📦 Other Neovim Plugin Managers in Lua](#-other-neovim-plugin-managers-in-lua)
|
||||
- [✨ Features](#-features)
|
||||
- [⚡️ Requirements](#%EF%B8%8F-requirements)
|
||||
- [📦 Installation](#-installation)
|
||||
- [🔌 Plugin Spec](#-plugin-spec)
|
||||
- [Lazy Loading](#lazy-loading)
|
||||
- [🌈 Colorschemes](#-colorschemes)
|
||||
- [⌨️ Lazy Key Mappings](#%EF%B8%8F-lazy-key-mappings)
|
||||
- [Versioning](#versioning)
|
||||
- [Examples](#examples)
|
||||
- [⚙️ Configuration](#%EF%B8%8F-configuration)
|
||||
- [🚀 Usage](#-usage)
|
||||
- [📆 User Events](#-user-events)
|
||||
- [🔒 Lockfile `lazy-lock.json`](#-lockfile-lazy-lockjson)
|
||||
- [⚡ Performance](#-performance)
|
||||
- [🪲 Debug](#-debug)
|
||||
- [▶️ Startup Sequence](#%EF%B8%8F-startup-sequence)
|
||||
- [📂 Structuring Your Plugins](#-structuring-your-plugins)
|
||||
- [📦 Migration Guide](#-migration-guide)
|
||||
- [packer.nvim](#packernvim)
|
||||
- [paq-nvim](#paq-nvim)
|
||||
- [❌ Uninstalling](#-uninstalling)
|
||||
- [🌈 Highlight Groups](#-highlight-groups)
|
||||
- [📦 Other Neovim Plugin Managers in Lua](#-other-neovim-plugin-managers-in-lua)
|
||||
<!-- 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
|
||||
|
||||
```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:
|
||||
|
||||
- [init.lua](https://github.com/folke/dot/blob/master/config/nvim/init.lua) where I require `config.lazy`
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue