Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lmantw/themify.nvim
A colorscheme manager and switcher designed for Neovim.
https://github.com/lmantw/themify.nvim
colorscheme manager neovim neovim-lua-plugin neovim-plugin
Last synced: 8 days ago
JSON representation
A colorscheme manager and switcher designed for Neovim.
- Host: GitHub
- URL: https://github.com/lmantw/themify.nvim
- Owner: LmanTW
- License: gpl-3.0
- Created: 2024-08-24T13:55:35.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-11-05T12:13:21.000Z (15 days ago)
- Last Synced: 2024-11-12T16:02:42.618Z (8 days ago)
- Topics: colorscheme, manager, neovim, neovim-lua-plugin, neovim-plugin
- Language: Lua
- Homepage:
- Size: 1.38 MB
- Stars: 24
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Themify
A colorscheme manager and switcher designed for [Neovim](https://neovim.io) written in [Lua](https://www.lua.org). Inspired by [Themery.nvim](https://github.com/zaldih/themery.nvim) and [Lazy.nvim](https://github.com/folke/lazy.nvim).
- 🎨 Easily install and manage your colorschemes.
- 🔍 Explore and preview 100+ colorschemes directly in Neovim.
- ⚡️ Optimized startup time with lazy-loaded colorschemes.
## 📦 Installation
> [!WARNING]
> Requirements: `Neovim >= 0.10`, `Git`
Use the package manager of your choice to install Theminify:
- [Lazy.nvim](https://github.com/folke/lazy.nvim)
```lua
{
'lmantw/themify.nvim',
lazy = false,
priority = 999,
config = {}
}
```
- [Packer.nvim](https://github.com/wbthomason/packer.nvim)
```lua
use {
'lmantw/themify.nvim',
config = {}
}
```
Manual Installation
```lua
local themify_path = vim.fs.joinpath(vim.fn.stdpath('data'), 'themify')
if not vim.loop.fs_stat(themify_path) then
vim.fn.system({
'git', 'clone',
'https://github.com/LmanTW/themify.nvim.git',
themify_path,
})
end
vim.opt.rtp:prepend(themify_path)
require('themify').setup()
```
## 🛠 Configuration
The configuration for Themify is really easy and stright forward, just call the `setup` function (or use the `config` option in your package manager) and add the colorschemes you want to install / manage:
```lua
require('themery').setup({
-- Your list of colorschemes.
'folke/tokyonight.nvim',
'Yazeed1s/minimal.nvim',
{
'sho-87/kanagawa-paper.nvim',
branch = 'master'
},
-- Built-in colorschemes are also supported.
-- (Also works with any colorschemes that are installed via other plugin manager, just make sure the colorscheme is loaded before Themify is loaded.)
'default'
})
```
> [!IMPORTANT]
> The colorschemes will not be installed automatically, please use the command `:Themify` to open the menu then press `I` to install all the colorschemes.
Advance Configuration
```lua
{
async = false,
-- Enable this would load the colorscheme asynchronously, which might improve your startup time.
{
'folke/tokyonight.nvim',
branch = 'main',
before = function()
-- The function run before the colorscheme is loaded.
end,
after = function()
-- The function run after the colorscheme is loaded.
end,
-- A colorscheme can have multiple themes, you can use the options below to only show the themes you want.
whitelist = {'tokyonight-night', 'tokyonight-day'},
blacklist = {}
}
}
```
## 📚 Colorscheme Database
Themify has a colorscheme database that can be access through the Explore page, you can search through the themes by using the `brightness` and `temperature` options.
> [!TIP]
> You can add a colorscheme to the database by [opening an issue](https://github.com/LmanTW/themify.nvim/issues/new/choose).
## 📎 Other
- [Colorscheme Database](./documents/database.md)
- [Highlight Groups](./documents/highlight.md)
- [API Documentation](./documents/api.md)
