bamboo.nvim

Dark green theme for Neovim $\ge$ 0.5 forked from OneDark.nvim. Theme written in Lua with Tree-sitter syntax highlighting.

For latest Tree-sitter syntax highlighting, upgrade to Neovim 0.8.0 or later, built with Tree-sitter 0.20.3+.

Features

Blue and purple are used sparingly to help reduce eye strain
Red, yellow, and green are prioritized more for the same reason
Comments are colored specifically to be readable and have good contrast with other text and background
Many semantic highlighting tokens are handled and colored nicely
Multiple plugins are supported with hand-picked, proper colors
Colors, Highlights and Code style of the theme can be customized as you like (Refer to Customization)

Regular (vulgaris)

Greener (multiplex)

NOTE: The above screenshots utilize Tree-sitter parsers for lua, markdown, markdown_inline, mermaid, and latex.

Installation

Install via your favorite package manager:

-- Using lazy.nvim
{
  'ribru17/bamboo.nvim',
  lazy = false,
  priority = 1000,
  config = function()
    require('bamboo').setup {
      -- optional configuration here
    }
    require('bamboo').load()
  end,
}

NOTE: For best results, use (rounded) borders for float windows (or change their background to a slightly different color than the main editor background).

Configuration

Enable theme

-- Lua
require('bamboo').load()

" Vim
colorscheme bamboo

Default Configuration

-- Lua
require('bamboo').setup  {
    -- Main options --
    style = 'vulgaris', -- Choose between 'vulgaris' (regular) and 'multiplex' (greener)
    toggle_style_key = nil, -- Keybind to toggle theme style. Leave it nil to disable it, or set it to a string, e.g. "<leader>ts"
    toggle_style_list = { 'vulgaris', 'multiplex' }, -- List of styles to toggle between (this option is essentially pointless now but will become useful if more style variations are added)
    transparent = false,  -- Show/hide background
    term_colors = true, -- Change terminal color as per the selected theme style
    ending_tildes = false, -- Show the end-of-buffer tildes. By default they are hidden
    cmp_itemkind_reverse = false, -- reverse item kind highlights in cmp menu

    -- Change code style ---
    -- Options are italic, bold, underline, none
    -- You can configure multiple style with comma separated, For e.g., keywords = 'italic,bold'
    code_style = {
        comments = 'italic',
        keywords = 'none',
        functions = 'none',
        strings = 'none',
        variables = 'none'
    },

    -- Lualine options --
    lualine = {
        transparent = false, -- lualine center bar transparency
    },

    -- Custom Highlights --
    colors = {}, -- Override default colors
    highlights = {}, -- Override highlight groups

    -- Plugins Config --
    diagnostics = {
        darker = false, -- darker colors for diagnostic
        undercurl = true,   -- use undercurl instead of underline for diagnostics
        background = true,    -- use background color for virtual text
    },
}

Vimscript Configuration

Bamboo can be configured also with Vimscript, using the global dictionary g:bamboo_config. NOTE: when setting boolean values use v:true and v:false instead of 0 and 1.

Example:

let g:bamboo_config = {
  \ 'ending_tildes': v:true,
  \ 'diagnostics': {
    \ 'darker': v:true,
    \ 'background': v:false,
  \ },
\ }
colorscheme bamboo

Customization

Example using custom colors and highlights:

require('bamboo').setup {
  colors = {
    bright_orange = "#ff8800",    -- define a new color
    green = '#00ffaa',            -- redefine an existing color
  },
  highlights = {
    ["@keyword"] = {fg = '$green'},
    ["@string"] = {fg = '$bright_orange', bg = '#00ff00', fmt = 'bold'},
    ["@function"] = {fg = '#0000ff', sp = '$cyan', fmt = 'underline,italic'},
    ["@function.builtin"] = {fg = '#0059ff'}
  }
}

Note that Tree-sitter keywords have been changed after Neovim version 0.8 and onwards. TS prefix is trimmed and lowercase words are separated with ..

The old way before neovim 0.8 looks like this. All highlights used in this colorscheme can be found in this file.

require('bamboo').setup {
  colors = {
    bright_orange = "#ff8800",    -- define a new color
    green = '#00ffaa',            -- redefine an existing color
  },
  highlights = {
    TSKeyword = {fg = '$green'},
    TSString = {fg = '$bright_orange', bg = '#00ff00', fmt = 'bold'},
    TSFunction = {fg = '#0000ff', sp = '$cyan', fmt = 'underline,italic'},
    TSFuncBuiltin = {fg = '#0059ff'}
  }
}

Plugins Supported

Reference

License

MIT

nadir-ishiguro / bamboo.nvim