Giter Club home page Giter Club logo

astrocommunity's Introduction

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 This can be done in your lua/community.lua file. If you're unfamiliar with configuring plugins, we recommend referring to the AstroNvim documentation.

Importing AstroCommunity Plugins

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

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.

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 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!

astrocommunity's People

Contributors

0xricksanchez avatar 20k-ultra avatar astronvimbot avatar chaozwn avatar dsisnero avatar fynnfluegge avatar gacallea avatar jay-babu avatar khaneliman avatar luxus avatar manuuurino avatar mehalter avatar owittek avatar pkazmier avatar rafaelderolez avatar rayjameson avatar rozhelluk avatar sacro avatar sjcobb2022 avatar souravpakhira avatar subjective avatar taskylizard avatar thesast avatar tku137 avatar utkarshgupta137 avatar uzaaft avatar whitemoon avatar windowsrefund avatar ypli0629 avatar zeioth avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.