Skip to content

Latest commit

 

History

11 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

CI

Vulkanite Banner

Vulkanite

Vulkanite is a dark Neovim colorscheme for real cool dudes. If you're a cool dude and you like cool dude colorschemes, maybe Vulkanite is for you.

Vulkanite editing Go

Vulkanite completion and diagnostics Vulkanite picker

Getting started

Neovim 0.10 or later and true-color support is required.

lazy.nvim

{
  "kyerpotts/vulkanite.nvim",
  lazy = false,
  priority = 1000,
  config = function()
    require("vulkanite").setup({})
    vim.cmd.colorscheme("vulkanite")
  end,
}

LazyVim

Current LazyVim releases require Neovim 0.11.2 or later. Add this to lua/plugins/vulkanite.lua and let LazyVim handle the final colorscheme load:

return {
  {
    "kyerpotts/vulkanite.nvim",
    lazy = false,
    priority = 1000,
    main = "vulkanite",
    opts = {},
  },
  {
    "LazyVim/LazyVim",
    opts = {
      colorscheme = "vulkanite",
    },
  },
}

Native vim.pack (Neovim 0.12+)

vim.pack.add({
  { src = "https://github.com/kyerpotts/vulkanite.nvim" },
})

require("vulkanite").setup({})
vim.cmd.colorscheme("vulkanite")

Configuration

Call setup() before loading the colorscheme if you want to change defaults:

require("vulkanite").setup({
  transparent = true,
  terminal_colors = true,
  styles = {
    comments = { italic = false },
    functions = { italic = true },
    types = { bold = true },
  },
})

vim.cmd.colorscheme("vulkanite")

Integrations

Vulkanite automatically detects supported plugins installed through lazy.nvim or vim.pack. Built-in highlights cover:

You can enable or disable individual integrations through plugins:

require("vulkanite").setup({
  plugins = {
    telescope = true,
    neo_tree = false,
  },
})

For lualine, load Vulkanite first and use the bundled theme:

require("lualine").setup({
  options = { theme = "vulkanite" },
})

Customization

Use on_colors for semantic colors and on_highlights for individual groups:

require("vulkanite").setup({
  on_colors = function(colors)
    colors.accent = "#8be086"
  end,
  on_highlights = function(highlights, colors)
    highlights.NormalFloat = { fg = colors.fg, bg = colors.bg }
  end,
})

Palette

Vulkanite authored palette

The named 16-color palette and its complete Base16 mapping are available from Lua:

local palette = require("vulkanite.palette").get()
local base16 = palette.base16

Documentation

The full option reference, integration keys, callback behavior, palette names, and compatibility notes are available inside Neovim:

:help vulkanite

You can also read doc/vulkanite.txt directly.

Project

Want to help? Read the contributing guide. You can also find the changelog, latest release notes, and MIT license here.

About

A super cool dude colorscheme for super cool dudes

Topics

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages