chore(build): auto-generate docs
This commit is contained in:
parent
d4c07d062d
commit
b3ee5b96f2
|
|
@ -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 <https://lazy.folke.io/>. 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
|
||||
<https://luarocks.org/>) that should be installed.
|
||||
- Packages <https://lazy.folke.io/packages> can now specify their dependencies
|
||||
and configuration using one of:
|
||||
- **Lazy**: `lazy.lua` file
|
||||
- **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)
|
||||
|
||||
|
||||
==============================================================================
|
||||
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 </packages> 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
|
||||
|
|
|
|||
Loadingโฆ
Reference in New Issue