https://github.com/alejandrosuero/colorscheme-installer.nvim

A colorscheme installer for NeoVim from the vimcolorscheme website
https://github.com/alejandrosuero/colorscheme-installer.nvim

color-scheme lazy-nvim neovim neovim-colorscheme neovim-colorschemes neovim-plugin neovim-theme theme

Last synced: 28 days ago
JSON representation

A colorscheme installer for NeoVim from the vimcolorscheme website

• Host: GitHub
• URL: https://github.com/alejandrosuero/colorscheme-installer.nvim
• Owner: AlejandroSuero
• License: mit
• Created: 2024-05-06T10:38:45.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-05-08T16:04:10.000Z (6 months ago)
• Last Synced: 2024-05-09T11:56:50.503Z (6 months ago)
• Topics: color-scheme, lazy-nvim, neovim, neovim-colorscheme, neovim-colorschemes, neovim-plugin, neovim-theme, theme
• Language: Lua
• Homepage: https://vimcolorschemes.com/
• Size: 48.8 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md

Awesome Lists containing this project

README

        


[![Test status badge](https://github.com/AlejandroSuero/colorscheme-installer.nvim/actions/workflows/test.yml/badge.svg)](https://github.com/AlejandroSuero/colorscheme-installer.nvim/actions/workflows/test.yml)

[![Issues badge](https://img.shields.io/github/issues/alejandrosuero/colorscheme-installer.nvim)](https://github.com/AlejandroSuero/colorscheme-installer.nvim/issues)

# NeoVim colorscheme installer

Install colorschemes into your [NeoVim](https://neovim.io) configuration from

itself.

[Report an issue](https://github.com/AlejandroSuero/colorscheme-installer.nvim/issues/new?assignees=&labels=bug&projects=&template=bug_report.yml&title=%5BBug%5D%3A+)

· [Suggest a feature](https://github.com/AlejandroSuero/colorscheme-installer.nvim/issues/new?assignees=&labels=enhancement&projects=&template=feature_request.md&title=%5BFeat%5D%3A+)



---

## Installation

This plugin supports [lazy.nvim](https://github.com/folke/lazy.nvim) installation.

- Default installation:

```lua

return {

    "AlejandroSuero/colorscheme-installer.nvim",

    config = function()

        require("colorscheme-installer").setup()

    end,

}

```

- Customizable installation:

```lua

return {

    "AlejandroSuero/colorscheme-installer.nvim",

    config = function()

        require("colorscheme-installer.nvim").setup({

            -- your configuration goes here

        })

    end,

}

```

> [!note]

> See default configuration.

## Default configuration

```lua

local opts = {

    -- path where the colorschemes will be configured

    colorschemes_path = os.getenv("HOME") .. "/.config/nvim/lua/colorschemes"

}

```

## Contributing

Thank you to everyone that is contributing and to those who want to contribute.

Any contribution is welcomed!

**Quick guide**:

1. [Fork](https://github.com/AlejandroSuero/colorscheme-installer.nvim/fork) this

   project.

2. Clone your fork (`git clone `).

3. Add main repo as remote (`git remote add upstream `).

4. Create a branch for your changes (`git switch -c feature/your-feature` or

   `git switch -c fix/your-fix`).

5. Commit your changes (`git commit -m "feat(...): ..."`).

6. Push to your fork (`git push origin `).

7. Open a [PR](https://github.com/AlejandroSuero/colorscheme-installer.nvim/pulls).

For more information, check [CONTRIBUTING.md](https://github.com/AlejandroSuero/colorscheme-installer.nvim/blob/main/contrib/CONTRIBUTING.md)