⛏️ Mine Shaft

An accessible color scheme for Neovim written in Lua

🧪 Code sample

🎨 Color palette

• Light text on a dark background
• Ratios meet or exceed WCAG AAA criteria for enhanced contrast

Color	Hex	Ratio	Normal Text	Large Text
Mine Shaft	#2b2b2b	background	N/A	N/A
Bright Turquoise	#00e0e0	8.59:1	AAA	AAA
Chino	#d4d0ab	9.04:1	AAA	AAA
Conifer	#abe338	9.29:1	AAA	AAA
Gold	#ffd700	10.09:1	AAA	AAA
Shilo	#e3aaa2	7.1:1	AAA	AAA
Snuff	#dcc6e0	8.90:1	AAA	AAA
Spring Wood	#f8f8f2	13.28:1	AAA	AAA
Vivid Tangerine	#ffa07a	7.12:1	AAA	AAA

📋 Requirements

• Neovim >= 0.8.0

🔌 Supported plugins

• NvimTree
• 💌 Submit an issue—better yet, a pull request—for other plugins

⬇️ Install

Install Mine Shaft with your preferred package manager:

Packer

use 'reubenlillie/mine-shaft'

Vim-Plug

Plug 'reubenlillie/mine-shaft'

🖌️ Use

Enable the color scheme:

Lua

vim.cmd[[colorscheme mine-shaft]]

Vim script

colorscheme mine-shaft

👷 Contributing

• 🫶 Pull requests are welcome!
• 📌 Check out the Code of Conduct

🏆 Colophon

• ♿ Color palette adapted from Eric Bailey’s a11y-syntax-highlighting

• 🧛 Code base takes cues from Mofiqul’s conversion of Vim’s default dracula color scheme to Lua