- Notifications
You must be signed in to change notification settings - Fork258
A community repository of common plugin specifications
License
AstroNvim/astrocommunity
Folders and files
Name | Name | Last commit message | Last commit date | |
---|---|---|---|---|
Repository files navigation
AstroNvim's community repository contains plugin configuration specifications — a collection of plugins contributed by the community for AstroNvim, a NeoVim configuration. These specifications help manage the variety of plugins used in AstroNvim.
To integrate the community plugins, add the provided configurations to yourplugins
setup preferably before you import your own plugins to guarantee all AstroCommunity changes are loaded before your own overrides. If you are using theAstroNvim Template This can be done in yourlua/community.lua
file. If you're unfamiliar with configuring plugins, we recommend referring to theAstroNvim documentation.
Integrate the following content within yourlua/community.lua
file:
return {"AstroNvim/astrocommunity", {import="astrocommunity.colorscheme.catppuccin"},-- ... import any community contributed plugins here}
Once you have AstroCommunity imports defined in yourlua/community.lua
you can then further customize the installations in your own plugin definitions (typically done in thelua/plugins/
directory). Here is an example assuming you have Catppuccin installed as shown above.
return { {-- further customize the options set by the community"catppuccin",opts= {integrations= {sandwich=false,noice=true,mini=true,leap=true,markdown=true,neotest=true,cmp=true,overseer=true,lsp_trouble=true,rainbow_delimiters=true, }, }, },}
Notes:
- To disable imports, set the
enabled
option tofalse
. You have two approaches to modify an existing plugin: use the full repository name (e.g., "m4xshen/smartcolumn.nvim") or the module name (e.g., "catppuccin"). Remember, the module name might differ from the folder name. - It's recommended to use the full import path when customizing a plugin, and not the shorthand notation of just the repository name.
- You can override many aspects of community plugins including settings, dependencies, and versions. For more details on available options, refer to thelazy.nvim documentation.
If you've written a plugin configuration and wish to add it with the AstroCommunity repository, please follow ourContribution Guidelines and submit a pull request. Ensure you've rigorously tested your changes before submission. This isn't an official repository, so its stability relies on community contributions. We're excited to see how this project grows and evolves!
About
A community repository of common plugin specifications