diff --git a/doc/lazy.nvim.txt b/doc/lazy.nvim.txt index c285841..1514b05 100644 --- a/doc/lazy.nvim.txt +++ b/doc/lazy.nvim.txt @@ -6,42 +6,28 @@ Table of Contents *lazy.nvim-table-of-contents* 1. πŸš€ Getting Started |lazy.nvim-πŸš€-getting-started| - ✨ Features |lazy.nvim-πŸš€-getting-started-✨-features| - ⚑️ Requirements |lazy.nvim-πŸš€-getting-started-⚑️-requirements| -2. πŸ› οΈ Installation |lazy.nvim-πŸ› οΈ-installation| - - Structured Setup |lazy.nvim-πŸ› οΈ-installation-structured-setup| - - Single File Setup |lazy.nvim-πŸ› οΈ-installation-single-file-setup| -3. πŸ”Œ Plugin Spec |lazy.nvim-πŸ”Œ-plugin-spec| + - Structured Setup |lazy.nvim-πŸš€-getting-started-structured-setup| + - Single File Setup |lazy.nvim-πŸš€-getting-started-single-file-setup| +2. πŸ”Œ Plugin Spec |lazy.nvim-πŸ”Œ-plugin-spec| - Source |lazy.nvim-πŸ”Œ-plugin-spec-source| - Loading |lazy.nvim-πŸ”Œ-plugin-spec-loading| - Setup |lazy.nvim-πŸ”Œ-plugin-spec-setup| - Lazy Loading |lazy.nvim-πŸ”Œ-plugin-spec-lazy-loading| - Versioning |lazy.nvim-πŸ”Œ-plugin-spec-versioning| - Advanced |lazy.nvim-πŸ”Œ-plugin-spec-advanced| -4. Examples |lazy.nvim-examples| -5. Lazy Loading |lazy.nvim-lazy-loading| - - 🌈 Colorschemes |lazy.nvim-lazy-loading-🌈-colorschemes| - - ⌨️ Lazy Key Mappings |lazy.nvim-lazy-loading-⌨️-lazy-key-mappings| -6. Versioning |lazy.nvim-versioning| - - Examples |lazy.nvim-versioning-examples| -7. πŸ“¦ Packages |lazy.nvim-πŸ“¦-packages| - - Lazy |lazy.nvim-πŸ“¦-packages-lazy| - - Rockspec |lazy.nvim-πŸ“¦-packages-rockspec| - - Packspec |lazy.nvim-πŸ“¦-packages-packspec| -8. βš™οΈ Configuration |lazy.nvim-βš™οΈ-configuration| -9. 🌈 Highlight Groups |lazy.nvim-🌈-highlight-groups| -10. πŸš€ Usage |lazy.nvim-πŸš€-usage| + - Examples |lazy.nvim-πŸ”Œ-plugin-spec-examples| + - Lazy Loading |lazy.nvim-πŸ”Œ-plugin-spec-lazy-loading| + - Versioning |lazy.nvim-πŸ”Œ-plugin-spec-versioning| + - Lazy |lazy.nvim-πŸ”Œ-plugin-spec-lazy| + - Rockspec |lazy.nvim-πŸ”Œ-plugin-spec-rockspec| + - Packspec |lazy.nvim-πŸ”Œ-plugin-spec-packspec| + - 🌈 Highlight Groups |lazy.nvim-πŸ”Œ-plugin-spec-🌈-highlight-groups| +3. πŸš€ Usage |lazy.nvim-πŸš€-usage| - ▢️ Startup Sequence |lazy.nvim-πŸš€-usage-▢️-startup-sequence| - πŸš€ Commands |lazy.nvim-πŸš€-usage-πŸš€-commands| - πŸ“† User Events |lazy.nvim-πŸš€-usage-πŸ“†-user-events| - ❌ Uninstalling |lazy.nvim-πŸš€-usage-❌-uninstalling| -11. πŸ”’ Lockfile |lazy.nvim-πŸ”’-lockfile| -12. πŸ“¦ Migration Guide |lazy.nvim-πŸ“¦-migration-guide| - - packer.nvim |lazy.nvim-πŸ“¦-migration-guide-packer.nvim| - - paq-nvim |lazy.nvim-πŸ“¦-migration-guide-paq-nvim| -13. ⚑ Profiling & Debug |lazy.nvim-⚑-profiling-&-debug| - - πŸ› Debug |lazy.nvim-⚑-profiling-&-debug-πŸ›-debug| -14. πŸ“‚ Structuring Your Plugins |lazy.nvim-πŸ“‚-structuring-your-plugins| -15. πŸ“š Plugin Developers |lazy.nvim-πŸ“š-plugin-developers| -16. Links |lazy.nvim-links| +4. Links |lazy.nvim-links| ============================================================================== 1. πŸš€ Getting Started *lazy.nvim-πŸš€-getting-started* @@ -75,10 +61,7 @@ Table of Contents *lazy.nvim-table-of-contents* - Neovim >= **0.8.0** (needs to be built with **LuaJIT**) - Git >= **2.19.0** (for partial clones support) - a Nerd Font **(optional)** - - -============================================================================== -2. πŸ› οΈ Installation *lazy.nvim-πŸ› οΈ-installation* + # πŸ› οΈ Installation import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; @@ -92,7 +75,7 @@ all available options. -STRUCTURED SETUP *lazy.nvim-πŸ› οΈ-installation-structured-setup* +STRUCTURED SETUP *lazy.nvim-πŸš€-getting-started-structured-setup* >lua require("config.lazy") @@ -135,7 +118,7 @@ file should return a table with the plugins you want to install. For more info see Structuring Your Plugins -SINGLE FILE SETUP *lazy.nvim-πŸ› οΈ-installation-single-file-setup* +SINGLE FILE SETUP *lazy.nvim-πŸš€-getting-started-single-file-setup* >lua -- Bootstrap lazy.nvim @@ -169,7 +152,7 @@ SINGLE FILE SETUP *lazy.nvim-πŸ› οΈ-installation-single-file-setup* ============================================================================== -3. πŸ”Œ Plugin Spec *lazy.nvim-πŸ”Œ-plugin-spec* +2. πŸ”Œ Plugin Spec *lazy.nvim-πŸ”Œ-plugin-spec* SOURCE *lazy.nvim-πŸ”Œ-plugin-spec-source* @@ -326,8 +309,7 @@ ADVANCED *lazy.nvim-πŸ”Œ-plugin-spec-advanced* import string? Import the given spec module. ---------------------------------------------------------------------------------------- -============================================================================== -4. Examples *lazy.nvim-examples* +EXAMPLES *lazy.nvim-πŸ”Œ-plugin-spec-examples* >lua return { @@ -420,8 +402,7 @@ ADVANCED *lazy.nvim-πŸ”Œ-plugin-spec-advanced* < -============================================================================== -5. Lazy Loading *lazy.nvim-lazy-loading* +LAZY LOADING *lazy.nvim-πŸ”Œ-plugin-spec-lazy-loading* **lazy.nvim** automagically lazy-loads Lua modules. This means that if you have a plugin `A` that is lazy-loaded and a plugin `B` that requires a module of @@ -438,14 +419,14 @@ Plugins will be lazy-loaded when one of the following is `true`: - `config.defaults.lazy == true` -🌈 COLORSCHEMES *lazy.nvim-lazy-loading-🌈-colorschemes* +🌈 COLORSCHEMES ~ Colorscheme plugins can be configured with `lazy=true`. The plugin will automagically load when doing `colorscheme foobar`. -⌨️ LAZY KEY MAPPINGS *lazy.nvim-lazy-loading-⌨️-lazy-key-mappings* +⌨️ LAZY KEY MAPPINGS ~ The `keys` property can be a `string` or `string[]` for simple normal-mode mappings, or it can be a `LazyKeysSpec` table with the following key-value @@ -476,8 +457,7 @@ function. < -============================================================================== -6. Versioning *lazy.nvim-versioning* +VERSIONING *lazy.nvim-πŸ”Œ-plugin-spec-versioning* If you want to install a specific revision of a plugin, you can use `commit`, `tag`, `branch`, `version`. @@ -486,7 +466,7 @@ The `version` property supports Semver ranges. -EXAMPLES *lazy.nvim-versioning-examples* +EXAMPLES ~ - `*`: latest stable version (this excludes pre-release versions) - `1.2.x`: any version that starts with `1.2`, such as `1.2.0`, `1.2.3`, etc. @@ -496,10 +476,7 @@ EXAMPLES *lazy.nvim-versioning-examples* - `>=1.2.3`: any version that is greater than or equal to `1.2.3`, such as `1.2.3`, `1.3.0`, `1.4.5`, etc. - `<1.2.3`: any version that is less than `1.2.3`, such as `1.1.0`, `1.0.5`, etc. - `<=1.2.3`: any version that is less than or equal to `1.2.3`, such as `1.2.3`, `1.1.0`, `1.0.5`, etc - - -============================================================================== -7. πŸ“¦ Packages *lazy.nvim-πŸ“¦-packages* + # πŸ“¦ Packages **lazy.nvim** supports three ways for plugins to define their dependencies and configuration. @@ -514,28 +491,24 @@ finds a package will be used. -LAZY *lazy.nvim-πŸ“¦-packages-lazy* +LAZY *lazy.nvim-πŸ”Œ-plugin-spec-lazy* Using a `lazy.lua` file is the recommended way to define your plugin dependencies and configuration. Syntax is the same as any plugin spec. -ROCKSPEC *lazy.nvim-πŸ“¦-packages-rockspec* +ROCKSPEC *lazy.nvim-πŸ”Œ-plugin-spec-rockspec* When a plugin contains a `*-scm-1.rockspec` file, **lazy.nvim** will automatically load its `rocks` dependencies. -PACKSPEC *lazy.nvim-πŸ“¦-packages-packspec* +PACKSPEC *lazy.nvim-πŸ”Œ-plugin-spec-packspec* Supports the pkg.json format, with a lazy extension in `lazy`. `lazy` can contain any valid lazy spec fields. They -will be added to the plugin’s spec. - - -============================================================================== -8. βš™οΈ Configuration *lazy.nvim-βš™οΈ-configuration* +will be added to the plugin’s spec. # βš™οΈ Configuration **lazy.nvim** comes with the following defaults: @@ -763,8 +736,7 @@ If you don’t want to use a Nerd Font, you can replace the icons with Unicode s < -============================================================================== -9. 🌈 Highlight Groups *lazy.nvim-🌈-highlight-groups* +🌈 HIGHLIGHT GROUPS *lazy.nvim-πŸ”Œ-plugin-spec-🌈-highlight-groups* ----------------------------------------------------------------------- Highlight Group Default Group Description @@ -839,7 +811,7 @@ If you don’t want to use a Nerd Font, you can replace the icons with Unicode s ----------------------------------------------------------------------- ============================================================================== -10. πŸš€ Usage *lazy.nvim-πŸš€-usage* +3. πŸš€ Usage *lazy.nvim-πŸš€-usage* ▢️ STARTUP SEQUENCE *lazy.nvim-πŸš€-usage-▢️-startup-sequence* @@ -1013,11 +985,7 @@ directories: - **lockfile**: `~/.config/nvim/lazy-lock.json` - Paths can differ if you changed `XDG` environment variables. - -============================================================================== -11. πŸ”’ Lockfile *lazy.nvim-πŸ”’-lockfile* - + Paths can differ if you changed `XDG` environment variables. ## πŸ”’ Lockfile After every **update**, the local lockfile (`lazy-lock.json`) is updated with the installed revisions. It is recommended to have this file under version control. @@ -1026,14 +994,10 @@ If you use your Neovim config on multiple machines, using the lockfile, you can ensure that the same version of every plugin is installed. If you are on another machine, you can do `:Lazy restore`, to update all your -plugins to the version from the lockfile. +plugins to the version from the lockfile. ## πŸ“¦ Migration Guide -============================================================================== -12. πŸ“¦ Migration Guide *lazy.nvim-πŸ“¦-migration-guide* - - -PACKER.NVIM *lazy.nvim-πŸ“¦-migration-guide-packer.nvim* +PACKER.NVIM ~ - `setup` ➑️ `init` - `requires` ➑️ `dependencies` @@ -1065,15 +1029,12 @@ as `dependencies` will always be lazy-loaded and loaded when the plugin is loaded. -PAQ-NVIM *lazy.nvim-πŸ“¦-migration-guide-paq-nvim* +PAQ-NVIM ~ - `as` ➑️ `name` - `opt` ➑️ `lazy` - `run` ➑️ `build` - - -============================================================================== -13. ⚑ Profiling & Debug *lazy.nvim-⚑-profiling-&-debug* + ## ⚑ Profiling & Debug Great care has been taken to make the startup code (`lazy.core`) as efficient as possible. During startup, all Lua files used before `VimEnter` or @@ -1088,14 +1049,12 @@ improve performance. The profiling view shows you why and how long it took to load your plugins. -πŸ› DEBUG *lazy.nvim-⚑-profiling-&-debug-πŸ›-debug* +πŸ› DEBUG ~ See an overview of active lazy-loading handlers and what’s in the module cache. - -============================================================================== -14. πŸ“‚ Structuring Your Plugins *lazy.nvim-πŸ“‚-structuring-your-plugins* +## πŸ“‚ Structuring Your Plugins Some users may want to split their plugin specs in multiple files. Instead of passing a spec table to `setup()`, you can use a Lua module. The specs from the @@ -1135,7 +1094,7 @@ For a real-life example, you can check LazyVim - lazyvim.plugins contains all the plugin specs that will be loaded -↩️ IMPORTING SPECS, CONFIG & OPTS ~ +↩️ IMPORTING SPECS, CONFIG & OPTS As part of a spec, you can add `import` statements to import additional plugin modules. Both of the `setup()` calls are equivalent: @@ -1164,11 +1123,7 @@ same plugin to your local specs, adding any keys you want to override / merge. `opts`, `dependencies`, `cmd`, `event`, `ft` and `keys` are always merged with the parent spec. Any other property will override the property from the parent -spec. - - -============================================================================== -15. πŸ“š Plugin Developers *lazy.nvim-πŸ“š-plugin-developers* +spec. # πŸ“š Plugin Developers To make it easier for users to install your plugin, you can include a package spec in your repo. @@ -1181,7 +1136,7 @@ This makes it easier for users, as they no longer need to specify a `build` command. ============================================================================== -16. Links *lazy.nvim-links* +4. Links *lazy.nvim-links* 1. *image*: https://user-images.githubusercontent.com/292349/208301737-68fb279c-ba70-43ef-a369-8c3e8367d6b1.png 2. *@theme/Tabs*: