mini.nvim/doc/mini-base16.txt at main · krig/mini.nvim

This repository was archived by the owner on Aug 28, 2025. It is now read-only.

Repository navigation

History

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

*mini.base16* Base16 colorscheme creation

*MiniBase16*

==============================================================================

Fast implementation of 'chriskempson/base16' color scheme (with Copyright

Extra features:

- Configurable automatic support of cterm colors (see |highlight-cterm|).

- Opinionated palette generator based only on background and foreground

colors.

Supported highlight groups:

- Built-in Neovim LSP and diagnostic.

- Plugins (either with explicit definition or by verification that default

highlighting works appropriately):

- 'echasnovski/mini.nvim'

- 'akinsho/bufferline.nvim'

- 'anuvyklack/hydra.nvim'

- 'DanilaMihailov/beacon.nvim'

- 'folke/lazy.nvim'

- 'folke/noice.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'

- 'justinmk/vim-sneak'

- 'ibhagwan/fzf-lua'

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

# Setup ~

This module needs a setup with `require('mini.base16').setup({})` (replace

`{}` with your `config` table). It will create global Lua table

`MiniBase16` which you can use for scripting or manually (with

`:lua MiniBase16.*`).

See |MiniBase16.config| for `config` structure and default values.

This module doesn't have runtime options, so using `vim.b.minibase16_config`

will have no effect here.

Example: >lua

require('mini.base16').setup({

palette = {

base00 = '#112641',

base01 = '#3a475e',

base02 = '#606b81',

base03 = '#8691a7',

base04 = '#d5dc81',

base05 = '#e2e98f',

base06 = '#eff69c',

base07 = '#fcffaa',

base08 = '#ffcfa0',

base09 = '#cc7e46',

base0A = '#46a436',

base0B = '#9ff895',

base0C = '#ca6ecf',

base0D = '#42f7ff',

base0E = '#ffc4ff',

base0F = '#00a5c5',

use_cterm = true,

plugins = {

default = false,

['echasnovski/mini.nvim'] = true,

})

# Notes ~

1. This is used to create plugin's colorschemes (see |mini.nvim-color-schemes|).

2. Using `setup()` doesn't actually create a |colorscheme|. It basically

creates a coordinated set of |highlight|s. To create your own theme:

- Put "myscheme.lua" file (name after your chosen theme name) inside

any "colors" directory reachable from 'runtimepath' ("colors" inside

your Neovim config directory is usually enough).

- Inside "myscheme.lua" call `require('mini.base16').setup()` with your

palette and only after that set |g:colors_name| to "myscheme".

------------------------------------------------------------------------------

*mini-base16-color-schemes*

*minischeme*

*minicyan*

Base16 colorschemes ~

This module comes with several pre-built color schemes. All of them are a

|MiniBase16| theme created with faster version of the following Lua code: >lua

require('mini.base16').setup({ palette = palette, use_cterm = true })

Activate them as regular |colorscheme| (for example, `:colorscheme minischeme`).

## minischeme ~

Blue and yellow main colors with high contrast and saturation palette.

Palettes are: >lua

-- For dark 'background':

MiniBase16.mini_palette('#112641', '#e2e98f', 75)

-- For light 'background':

MiniBase16.mini_palette('#e2e5ca', '#002a83', 75)

## minicyan ~

Cyan and grey main colors with moderate contrast and saturation palette.

Palettes are: >lua

-- For dark 'background':

MiniBase16.mini_palette('#0A2A2A', '#D0D0D0', 50)

-- For light 'background':

MiniBase16.mini_palette('#C0D2D2', '#262626', 80)

------------------------------------------------------------------------------

*MiniBase16.setup()*

`MiniBase16.setup`({config})

Module setup

Setup is done by applying base16 palette to enable colorscheme. Highlight

groups make an extended set from original

[base16-vim](https://github.com/chriskempson/base16-vim/) plugin. It is a

good idea to have `config.palette` respect the original [styling

principles](https://github.com/chriskempson/base16/blob/master/styling.md).

By default only 'gui highlighting' (see |highlight-gui| and

|termguicolors|) is supported. To support 'cterm highlighting' (see

|highlight-cterm|) supply `config.use_cterm` argument in one of the formats:

- `true` to auto-generate from `palette` (as closest colors).

- Table with similar structure to `palette` but having terminal colors

(integers from 0 to 255) instead of hex strings.

Parameters ~

{config} `(table)` Module config table. See |MiniBase16.config|.

Usage ~

>lua

require('mini.base16').setup({}) -- replace {} with your config table

-- needs `palette` field present

------------------------------------------------------------------------------

*MiniBase16.config*

`MiniBase16.config`

Module config

Default values:

>lua

MiniBase16.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 },

}

# Options ~

## Plugin integrations ~

`config.plugins` defines for which supported plugins highlight groups will

be created. Limiting number of integrations slightly decreases startup time.

It is a table with boolean (`true`/`false`) values which are applied as follows:

- If plugin name (as listed in |mini.base16|) has entry, it is used.

- Otherwise `config.plugins.default` is used.

Example which will load only "mini.nvim" integration: >lua

require('mini.base16').setup({

palette = require('mini.base16').mini_palette('#112641', '#e2e98f', 75),

plugins = {

default = false,

['echasnovski/mini.nvim'] = true,

}

})

------------------------------------------------------------------------------

*MiniBase16.mini_palette()*

`MiniBase16.mini_palette`({background}, {foreground}, {accent_chroma})

Create 'mini' palette

Create base16 palette based on the HEX (string '#RRGGBB') colors of main

background and foreground with optional setting of accent chroma (see

details).

# Algorithm design ~

- Main operating color space is

[CIELCh(uv)](https://en.wikipedia.org/wiki/CIELUV#Cylindrical_representation_(CIELCh))

which is a cylindrical representation of a perceptually uniform CIELUV

color space. It defines color by three values: lightness L (values from 0

to 100), chroma (positive values), and hue (circular values from 0 to 360

degrees). Useful converting tool: https://www.easyrgb.com/en/convert.php

- There are four important lightness values: background, foreground, focus

(around the middle of background and foreground, leaning towards

foreground), and edge (extreme lightness closest to foreground).

- First four colors have the same chroma and hue as `background` but

lightness progresses from background towards focus.

- Second four colors have the same chroma and hue as `foreground` but

lightness progresses from foreground towards edge in such a way that

'base05' color is main foreground color.

- The rest eight colors are accent colors which are created in pairs

- Each pair has same hue from set of hues 'most different' to

background and foreground hues (if respective chorma is positive).

- All colors have the same chroma equal to `accent_chroma` (if not

provided, chroma of foreground is used, as they will appear next

to each other). Note: this means that in case of low foreground

chroma, it is a good idea to set `accent_chroma` manually.

Values from 30 (low chorma) to 80 (high chroma) are common.

- Within pair there is base lightness (equal to foreground

lightness) and alternative (equal to focus lightness). Base

lightness goes to colors which will be used more frequently in

code: base08 (variables), base0B (strings), base0D (functions),

base0E (keywords).

How exactly accent colors are mapped to base16 palette is a result of

trial and error. One rule of thumb was: colors within one hue pair should

be more often seen next to each other. This is because it is easier to

distinguish them and seems to be more visually appealing. That is why

`base0D` and `base0F` have same hues because they usually represent

functions and delimiter (brackets included).

Parameters ~

{background} `(string)` Background HEX color (formatted as `#RRGGBB`).

{foreground} `(string)` Foreground HEX color (formatted as `#RRGGBB`).

{accent_chroma} `(number)` Optional positive number (usually between 0

and 100). Default: chroma of foreground color.

Return ~

`(table)` Table with base16 palette.

Usage ~

>lua

local p = require('mini.base16').mini_palette('#112641', '#e2e98f', 75)

require('mini.base16').setup({ palette = p })

------------------------------------------------------------------------------

*MiniBase16.rgb_palette_to_cterm_palette()*

`MiniBase16.rgb_palette_to_cterm_palette`({palette})

Converts palette with RGB colors to terminal colors

Useful for caching `use_cterm` variable to increase speed.

Parameters ~

{palette} `(table)` Table with base16 palette (same as in

`MiniBase16.config.palette`).

Return ~

`(table)` Table with base16 palette using |highlight-cterm|.

vim:tw=78:ts=8:noet:ft=help:norl:

FilesExpand file tree

mini-base16.txt

Latest commit

History

mini-base16.txt

File metadata and controls