Mini.base16
Neovim Lua plugin for Base16 colorscheme creation. Part of 'mini.nvim' library.
Install / Use
/learn @nvim-mini/Mini.base16README
Fast implementation of chriskempson/base16 theme for manually supplied palette
- Supports 30+ plugin integrations.
- Has unique palette generator which needs only background and foreground colors.
- Comes with several hand-picked color schemes.
See more details in Features and Documentation.
[!NOTE] This was previously hosted at a personal
echasnovskiGitHub account. It was transferred to a dedicated organization to improve long term project stability. See more details here.
⦿ This is a part of mini.nvim library. Please use this link if you want to mention this module.
⦿ All contributions (issues, pull requests, discussions, etc.) are done inside of 'mini.nvim'.
⦿ See whole library documentation to learn about general design principles, disable/configuration recipes, and more.
⦿ See MiniMax for a full config example that uses this module.
If you want to help this project grow but don't know where to start, check out contributing guides of 'mini.nvim' or leave a Github star for 'mini.nvim' project and/or any its standalone Git repositories.
Demo
Using minischeme color scheme:
<a href="https://github.com/nvim-mini/assets/blob/main/demo/demo-base16_minischeme-dark.png?raw=true"> <img alt="minischeme dark" src="https://github.com/nvim-mini/assets/blob/main/demo/demo-base16_minischeme-dark.png?raw=true" style="width: 45%"/> </a> <a href="https://github.com/nvim-mini/assets/blob/main/demo/demo-base16_minischeme-light.png?raw=true"> <img alt="minischeme light" src="https://github.com/nvim-mini/assets/blob/main/demo/demo-base16_minischeme-light.png?raw=true" style="width: 45%"/> </a>
Using minicyan color scheme:
<a href="https://github.com/nvim-mini/assets/blob/main/demo/demo-base16_minicyan-dark.png?raw=true"> <img alt="minicyan dark" src="https://github.com/nvim-mini/assets/blob/main/demo/demo-base16_minicyan-dark.png?raw=true" style="width: 45%"/> </a> <a href="https://github.com/nvim-mini/assets/blob/main/demo/demo-base16_minicyan-light.png?raw=true"> <img alt="minicyan light" src="https://github.com/nvim-mini/assets/blob/main/demo/demo-base16_minicyan-light.png?raw=true" style="width: 45%"/> </a>
Features
Supported highlight groups:
- Built-in Neovim LSP and diagnostic.
- Plugins (either with explicit definition or by verification that default
highlighting works appropriately):
- nvim-mini/mini.nvim
- akinsho/bufferline.nvim
- anuvyklack/hydra.nvim
- DanilaMihailov/beacon.nvim
- folke/lazy.nvim
- folke/noice.nvim
- folke/snacks.nvim
- folke/todo-comments.nvim
- folke/trouble.nvim
- folke/which-key.nvim
- ggandor/leap.nvim
- ggandor/lightspeed.nvim
- glepnir/dashboard-nvim
- glepnir/lspsaga.nvim
- HiPhish/rainbow-delimiters.nvim
- hrsh7th/nvim-cmp
- ibhagwan/fzf-lua
- justinmk/vim-sneak
- kevinhwang91/nvim-bqf
- kevinhwang91/nvim-ufo
- lewis6991/gitsigns.nvim
- lukas-reineke/indent-blankline.nvim
- MeanderingProgrammer/render-markdown.nvim
- neoclide/coc.nvim
- NeogitOrg/neogit
- nvim-lualine/lualine.nvim
- nvim-neo-tree/neo-tree.nvim
- nvim-telescope/telescope.nvim
- nvim-tree/nvim-tree.lua
- OXY2DEV/helpview.nvim
- OXY2DEV/markview.nvim
- phaazon/hop.nvim
- rcarriga/nvim-dap-ui
- rcarriga/nvim-notify
- rlane/pounce.nvim
- romgrk/barbar.nvim
- stevearc/aerial.nvim
- williamboman/mason.nvim
Installation
This plugin can be installed as part of 'mini.nvim' library (recommended) or as a standalone Git repository.
There are two branches to install from:
main(default, recommended) will have latest development version of plugin. All changes since last stable release should be perceived as being in beta testing phase (meaning they already passed alpha-testing and are moderately settled).stablewill be updated only upon releases with code tested during public beta-testing phase inmainbranch.
Here are code snippets for some common installation methods (use only one):
<details> <summary>With <a href="https://nvim-mini.org/mini.nvim/readmes/mini-deps">mini.deps</a></summary>-
'mini.nvim' library:
| Branch | Code snippet | |--------|-----------------------------------------------| | Main | Follow recommended 'mini.deps' installation | | Stable | Follow recommended 'mini.deps' installation |
-
Standalone plugin:
| Branch | Code snippet | |--------|------------------------------------------------------------------| | Main |
add('nvim-mini/mini.base16')| | Stable |add({ source = 'nvim-mini/mini.base16', checkout = 'stable' })|
-
'mini.nvim' library:
| Branch | Code snippet | |--------|-----------------------------------------------| | Main |
{ 'nvim-mini/mini.nvim', version = false },| | Stable |{ 'nvim-mini/mini.nvim', version = '*' },| -
Standalone plugin:
| Branch | Code snippet | |--------|-------------------------------------------------| | Main |
{ 'nvim-mini/mini.base16', version = false },| | Stable |{ 'nvim-mini/mini.base16', version = '*' },|
-
'mini.nvim' library:
| Branch | Code snippet | |--------|------------------------------------------------------| | Main |
Plug 'nvim-mini/mini.nvim'| | Stable |Plug 'nvim-mini/mini.nvim', { 'branch': 'stable' }| -
Standalone plugin:
| Branch | Code snippet | |--------|--------------------------------------------------------| | Main |
Plug 'nvim-mini/mini.base16'| | Stable |Plug 'nvim-mini/mini.base16', { 'branch': 'stable' }|
Important: don't forget to call require('mini.base16').setup() with appropriate palette to enable its functionality.
Note: if you are on Windows, there might be problems with too long file paths (like error: unable to create file <some file name>: Filename too long). Try doing one of the following:
- Enable corresponding git global config value:
git config --system core.longpaths true. Then try to reinstall. - Install plugin in other place with shorter path.
Default config
{
-- Table with names from `base00` to `base0F` and values being strings of
-- HEX colors with format "#RRGGBB". NOTE: this should be explicitly
-- supplied in `setup()`.
palette = nil,
-- Whether to support cterm colors. Can be boolean, `nil` (same as
-- `false`), or table with cterm colors. See `setup()` documentation for
-- more information.
use_cterm = nil,
-- Plugin integrations. Use `default = false` to disable all integrations.
-- Also can be set per plugin (see |MiniBase16.config|).
plugins = { default = true },
}
