https://github.com/AstroNvim/astrocommunity

A community repository of common plugin specifications
https://github.com/AstroNvim/astrocommunity

astronvim astrovim hacktoberfest lazy lazynvim lua neovim neovim-lua-plugin neovim-plugin

Last synced: 14 days ago
JSON representation

A community repository of common plugin specifications

• Host: GitHub
• URL: https://github.com/AstroNvim/astrocommunity
• Owner: AstroNvim
• License: gpl-3.0
• Created: 2023-02-21T14:55:56.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-10-29T19:45:09.000Z (14 days ago)
• Last Synced: 2024-10-29T21:41:42.453Z (14 days ago)
• Topics: astronvim, astrovim, hacktoberfest, lazy, lazynvim, lua, neovim, neovim-lua-plugin, neovim-plugin
• Language: Lua
• Homepage:
• Size: 2.16 MB
• Stars: 1,198
• Watchers: 18
• Forks: 241
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        


  



AstroNvim Community Repository




  

    

  

  

    

  

  

    

  

  

    

  

  

    

  

  

    

  

  

    

  

  

    

  

  

    

  

  

    

  

  

    

  

  

    

  

  

    

  

  

    

  

  

    

  

  

    

  

  

    

  

  

    

  

  

    

  

  

    

  

  

    

  

  

    

  

  

    

  

  

    

  

  

    

  

  

    

  

  

    

  

  

    

  

  

    

  

  

    

  

  

    

  



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.

## 📦 Setup

To integrate the community plugins, add the provided configurations to your `plugins` setup preferably before you import your own plugins to guarantee all AstroCommunity changes are loaded before your own overrides. If you are using the [AstroNvim Template](https://github.com/AstroNvim/template) This can be done in your `lua/community.lua` file. If you're unfamiliar with configuring plugins, we recommend referring to the [AstroNvim documentation](https://docs.astronvim.com/configuration/customizing_plugins/).

### Importing AstroCommunity Plugins

Integrate the following content within your `lua/community.lua` file:

```lua

return {

  "AstroNvim/astrocommunity",

  { import = "astrocommunity.colorscheme.catppuccin" },

  -- ... import any community contributed plugins here

}

```

### Customizing AstroCommunity Installations

Once you have AstroCommunity imports defined in your `lua/community.lua` you can then further customize the installations in your own plugin definitions (typically done in the `lua/plugins/` directory). Here is an example assuming you have Catppuccin installed as shown above.

```lua

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 to `false`. 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.

## Contributing

If you've written a plugin configuration and wish to add it with the AstroCommunity repository, please follow our [Contribution Guidelines](./CONTRIBUTING.md) 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!