Skip to content

anttikivi/brunch.nvim

Repository files navigation

🥂 Brunch

Brunch is a cheerful 🎉 and colourful 🌈 light and dark theme for Neovim using only 8-bit ANSI colours. It aims to offer a nicer theme for users with terminals without support for true colours.

Preview of the Brunch colour scheme

🎨 Palettes

🧁 Sunday Preview of the Sunday variant the Brunch colour scheme
☕️ Saturday Preview of the Saturday variant the Brunch colour scheme

⭐️ Motivation

There are a lot of great themes for Neovim, but most of them require true colours. You may sometimes want to or have to use a terminal that doesn’t support those. More specifically, I haven’t found a theme that I like with the macOS Terminal.app.

Brunch is a Catppuccin-inspired theme that aims to be a good-looking and usable theme for users with terminals that don’t have support for true colours.

✨ Features

  • Supports most Neovim features.
  • Usable as-is with terminals that support only 8-bit ANSI colours.
  • Enhances terminal colours.
  • Includes a light and dark theme.
  • Integrates with many major plugins.

📦 Installation

Use your preferred plugin manager to install Brunch.

lazy.nvim

{ "anttikivi/brunch.nvim", priority = 1000 }

packer.nvim

use { "anttikivi/brunch.nvim" }

vim-plug

Plug 'anttikivi/brunch.nvim'

🚀 Usage

Vimscript

colorscheme brunch

Lua

vim.cmd.colorscheme 'brunch'

⚙️ Configuration

❗️ Note: Make sure to call setup before setting the colour scheme with colorscheme brunch if you want to change the default options and settings.

You don’t need to call setup if you don’t want to change the default options and settings.

require('brunch').setup {
  -- Sets the theme variant to use according to vim.o.background. The possible
  -- values for the variants are 'sunday' and 'saturday'.
  variants = {
    dark = 'saturday',
    light = 'sunday',
  },
  -- Configure the colors used when opening a `:terminal` in Neovim.
  terminal_colors = false,
  -- Style to be applied to various highlight groups.
  styles = {
    booleans = {},
    comments = { 'italic' },
    conditional = { 'italic' },
    functions = {},
    keywords = {},
    loops = {},
    numbers = {},
    operators = {},
    properties = {},
    strings = {},
    types = {},
    variables = {},
  },
}

📝 Licence

This project is licensed under the Apache-2.0 licence. See the LICENSE file for more information.

About

🥂 A cheerful theme for Neovim using 8-bit ANSI colours

Resources

License

Stars

Watchers

Forks

Languages