lazy.nvim/README.md

69 lines
3.6 KiB
Markdown
Raw Permalink Normal View History

2024-06-24 03:07:44 +08:00
<h4 align="center">
<a href="https://lazy.folke.io/installation">Install</a>
·
<a href="https://lazy.folke.io/configuration">Configure</a>
·
<a href="https://lazy.folke.io">Docs</a>
</h4>
<div align="center"><p>
<a href="https://github.com/folke/lazy.nvim/releases/latest">
<img alt="Latest release" src="https://img.shields.io/github/v/release/folke/lazy.nvim?style=for-the-badge&logo=starship&color=C9CBFF&logoColor=D9E0EE&labelColor=302D41&include_prerelease&sort=semver" />
</a>
<a href="https://github.com/folke/lazy.nvim/pulse">
<img alt="Last commit" src="https://img.shields.io/github/last-commit/folke/lazy.nvim?style=for-the-badge&logo=starship&color=8bd5ca&logoColor=D9E0EE&labelColor=302D41"/>
</a>
<a href="https://github.com/folke/lazy.nvim/blob/main/LICENSE">
<img alt="License" src="https://img.shields.io/github/license/folke/lazy.nvim?style=for-the-badge&logo=starship&color=ee999f&logoColor=D9E0EE&labelColor=302D41" />
</a>
<a href="https://github.com/folke/lazy.nvim/stargazers">
<img alt="Stars" src="https://img.shields.io/github/stars/folke/lazy.nvim?style=for-the-badge&logo=starship&color=c69ff5&logoColor=D9E0EE&labelColor=302D41" />
</a>
<a href="https://github.com/folke/lazy.nvim/issues">
<img alt="Issues" src="https://img.shields.io/github/issues/folke/lazy.nvim?style=for-the-badge&logo=bilibili&color=F5E0DC&logoColor=D9E0EE&labelColor=302D41" />
</a>
<a href="https://github.com/folke/lazy.nvim">
<img alt="Repo Size" src="https://img.shields.io/github/repo-size/folke/lazy.nvim?color=%23DDB6F2&label=SIZE&logo=codesandbox&style=for-the-badge&logoColor=D9E0EE&labelColor=302D41" />
</a>
<a href="https://twitter.com/intent/follow?screen_name=folke">
<img alt="follow on Twitter" src="https://img.shields.io/twitter/follow/folke?style=for-the-badge&logo=twitter&color=8aadf3&logoColor=D9E0EE&labelColor=302D41" />
</a>
</div>
2022-12-15 04:04:04 +08:00
2022-12-15 05:10:45 +08:00
**lazy.nvim** is a modern plugin manager for Neovim.
2022-11-26 21:31:29 +08:00
2022-12-18 21:46:33 +08:00
![image](https://user-images.githubusercontent.com/292349/208301737-68fb279c-ba70-43ef-a369-8c3e8367d6b1.png)
2022-12-15 04:05:25 +08:00
2022-11-28 14:36:46 +08:00
## ✨ Features
2022-12-20 02:49:47 +08:00
- 📦 Manage all your Neovim plugins with a powerful UI
- 🚀 Fast startup times thanks to automatic caching and bytecode compilation of Lua modules
2022-12-15 04:04:04 +08:00
- 💾 Partial clones instead of shallow clones
- 🔌 Automatic lazy-loading of Lua modules and lazy-loading on events, commands, filetypes, and key mappings
2022-12-20 04:27:36 +08:00
- ⏳ Automatically install missing plugins before starting up Neovim, allowing you to start using it right away
2022-12-15 04:04:04 +08:00
- 💪 Async execution for improved performance
- 🛠️ No need to manually compile plugins
- 🧪 Correct sequencing of dependencies
- 📁 Configurable in multiple files
- 📚 Generates helptags of the headings in `README.md` files for plugins that don't have vimdocs
2022-12-15 05:10:45 +08:00
- 💻 Dev options and patterns for using local plugins
2022-12-15 04:04:04 +08:00
- 📊 Profiling tools to optimize performance
2022-12-15 05:10:45 +08:00
- 🔒 Lockfile `lazy-lock.json` to keep track of installed plugins
2022-12-15 04:04:04 +08:00
- 🔎 Automatically check for updates
- 📋 Commit, branch, tag, version, and full [Semver](https://devhints.io/semver) support
- 📈 Statusline component to see the number of pending updates
- 🎨 Automatically lazy-loads colorschemes
2022-12-15 04:04:04 +08:00
2022-12-15 04:24:51 +08:00
## ⚡️ Requirements
2022-12-18 18:58:40 +08:00
- Neovim >= **0.8.0** (needs to be built with **LuaJIT**)
- Git >= **2.19.0** (for partial clones support)
- a [Nerd Font](https://www.nerdfonts.com/) **_(optional)_**
2024-06-24 23:42:27 +08:00
- [luarocks](https://luarocks.org/) to install rockspecs.
You can remove `rockspec` from `opts.pkg.sources` to disable this feature.
2022-12-15 04:24:51 +08:00
2024-06-24 03:07:44 +08:00
## 🚀 Getting Started
2022-12-01 06:15:14 +08:00
2024-06-24 03:07:44 +08:00
Check the [documentation website](https://lazy.folke.io/) for more information.