From 66249054c40b816a44a43a5b912bb6c8f763c153 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Mon, 24 Jun 2024 06:35:54 +0000 Subject: [PATCH] chore(build): auto-generate docs --- doc/lazy.nvim.txt | 56 +++++++++++++++++++++++++++++++++-------------- 1 file changed, 40 insertions(+), 16 deletions(-) diff --git a/doc/lazy.nvim.txt b/doc/lazy.nvim.txt index 8562034..ed9bcad 100644 --- a/doc/lazy.nvim.txt +++ b/doc/lazy.nvim.txt @@ -3,13 +3,15 @@ ============================================================================== Table of Contents *lazy.nvim-table-of-contents* -1. πŸš€ Getting Started |lazy.nvim-πŸš€-getting-started| +1. πŸ“° What’s new? |lazy.nvim-πŸ“°-what’s-new?| + - 11.x |lazy.nvim-πŸ“°-what’s-new?-11.x| +2. πŸš€ Getting Started |lazy.nvim-πŸš€-getting-started| - ✨ Features |lazy.nvim-πŸš€-getting-started-✨-features| - ⚑️ Requirements |lazy.nvim-πŸš€-getting-started-⚑️-requirements| -2. πŸ› οΈ Installation |lazy.nvim-πŸ› οΈ-installation| +3. πŸ› οΈ 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| +4. πŸ”Œ Plugin Spec |lazy.nvim-πŸ”Œ-plugin-spec| - Spec Source |lazy.nvim-πŸ”Œ-plugin-spec-spec-source| - Spec Loading |lazy.nvim-πŸ”Œ-plugin-spec-spec-loading| - Spec Setup |lazy.nvim-πŸ”Œ-plugin-spec-spec-setup| @@ -19,13 +21,13 @@ Table of Contents *lazy.nvim-table-of-contents* - Examples |lazy.nvim-πŸ”Œ-plugin-spec-examples| - Lazy Loading |lazy.nvim-πŸ”Œ-plugin-spec-lazy-loading| - Versioning |lazy.nvim-πŸ”Œ-plugin-spec-versioning| -4. πŸ“¦ Packages |lazy.nvim-πŸ“¦-packages| +5. πŸ“¦ Packages |lazy.nvim-πŸ“¦-packages| - Lazy |lazy.nvim-πŸ“¦-packages-lazy| - Rockspec |lazy.nvim-πŸ“¦-packages-rockspec| - Packspec |lazy.nvim-πŸ“¦-packages-packspec| -5. βš™οΈ Configuration |lazy.nvim-βš™οΈ-configuration| +6. βš™οΈ Configuration |lazy.nvim-βš™οΈ-configuration| - 🌈 Highlight Groups|lazy.nvim-βš™οΈ-configuration-🌈-highlight-groups| -6. πŸš€ Usage |lazy.nvim-πŸš€-usage| +7. πŸš€ Usage |lazy.nvim-πŸš€-usage| - ▢️ Startup Sequence |lazy.nvim-πŸš€-usage-▢️-startup-sequence| - πŸš€ Commands |lazy.nvim-πŸš€-usage-πŸš€-commands| - πŸ“† User Events |lazy.nvim-πŸš€-usage-πŸ“†-user-events| @@ -34,11 +36,33 @@ Table of Contents *lazy.nvim-table-of-contents* - πŸ“¦ Migration Guide |lazy.nvim-πŸš€-usage-πŸ“¦-migration-guide| - ⚑ Profiling & Debug |lazy.nvim-πŸš€-usage-⚑-profiling-&-debug| - πŸ“‚ Structuring Your Plugins|lazy.nvim-πŸš€-usage-πŸ“‚-structuring-your-plugins| -7. πŸ“š Plugin Developers |lazy.nvim-πŸ“š-plugin-developers| -8. Links |lazy.nvim-links| +8. πŸ“š Plugin Developers |lazy.nvim-πŸ“š-plugin-developers| +9. Links |lazy.nvim-links| ============================================================================== -1. πŸš€ Getting Started *lazy.nvim-πŸš€-getting-started* +1. πŸ“° What’s new? *lazy.nvim-πŸ“°-what’s-new?* + + +11.X *lazy.nvim-πŸ“°-what’s-new?-11.x* + +- **New Website**: There’s a whole new website with a fresh look and improved + documentation. Check it out at lazy.nvim . The GitHub + `README.md` has been updated to point to the new website. The `vimdoc` contains + all the information that is available on the website. +- **Spec Resolution & Merging**: the code that resolves a final spec from a + plugin’s fragments has been rewritten. This should be a tiny bit faster, but + more importantly, fixes some issues and is easier to maintain. +- `rocks`: specs can now specify a list of rocks (luarocks + ) that should be installed. +- Packages can now specify their dependencies + and configuration using one of: + - **Lazy**: `lazy.lua` file + - **Rockspec**: luarocks `*-scm-1.rockspec` file + - **Packspec**: `pkg.json` (experimental, since the format is not quite there yet) + + +============================================================================== +2. πŸš€ Getting Started *lazy.nvim-πŸš€-getting-started* **lazy.nvim** is a modern plugin manager for Neovim. @@ -72,7 +96,7 @@ Table of Contents *lazy.nvim-table-of-contents* ============================================================================== -2. πŸ› οΈ Installation *lazy.nvim-πŸ› οΈ-installation* +3. πŸ› οΈ Installation *lazy.nvim-πŸ› οΈ-installation* There are multiple ways to install **lazy.nvim**. The **Structured Setup** is the recommended way, but you can also use the **Single File Setup** if you @@ -161,7 +185,7 @@ SINGLE FILE SETUP *lazy.nvim-πŸ› οΈ-installation-single-file-setup* ============================================================================== -3. πŸ”Œ Plugin Spec *lazy.nvim-πŸ”Œ-plugin-spec* +4. πŸ”Œ Plugin Spec *lazy.nvim-πŸ”Œ-plugin-spec* SPEC SOURCE *lazy.nvim-πŸ”Œ-plugin-spec-spec-source* @@ -488,7 +512,7 @@ EXAMPLES ~ ============================================================================== -4. πŸ“¦ Packages *lazy.nvim-πŸ“¦-packages* +5. πŸ“¦ Packages *lazy.nvim-πŸ“¦-packages* **lazy.nvim** supports three ways for plugins to define their dependencies and configuration. @@ -524,7 +548,7 @@ will be added to the plugin’s spec. ============================================================================== -5. βš™οΈ Configuration *lazy.nvim-βš™οΈ-configuration* +6. βš™οΈ Configuration *lazy.nvim-βš™οΈ-configuration* **lazy.nvim** comes with the following defaults: @@ -826,7 +850,7 @@ If you don’t want to use a Nerd Font, you can replace the icons with Unicode s ----------------------------------------------------------------------- ============================================================================== -6. πŸš€ Usage *lazy.nvim-πŸš€-usage* +7. πŸš€ Usage *lazy.nvim-πŸš€-usage* ▢️ STARTUP SEQUENCE *lazy.nvim-πŸš€-usage-▢️-startup-sequence* @@ -1151,7 +1175,7 @@ spec. ============================================================================== -7. πŸ“š Plugin Developers *lazy.nvim-πŸ“š-plugin-developers* +8. πŸ“š Plugin Developers *lazy.nvim-πŸ“š-plugin-developers* To make it easier for users to install your plugin, you can include a package spec in your repo. @@ -1164,7 +1188,7 @@ This makes it easier for users, as they no longer need to specify a `build` command. ============================================================================== -8. Links *lazy.nvim-links* +9. Links *lazy.nvim-links* 1. *image*: https://user-images.githubusercontent.com/292349/208301737-68fb279c-ba70-43ef-a369-8c3e8367d6b1.png 2. *image*: https://user-images.githubusercontent.com/292349/208301766-5c400561-83c3-4811-9667-1ec4bb3c43b8.png