Skip to content

Latest commit

 

History

History
74 lines (50 loc) · 1.9 KB

THEME_README.md

File metadata and controls

74 lines (50 loc) · 1.9 KB

My Theme



preview



Installation

  1. Using Lazy:
{ 'my-user/my-theme.nvim' },
  1. Using Packer:
use 'my-user/my-theme.nvim'

Configuration

To configure the plugin, you can call require('my-theme').setup({}), passing the table with the values in it. The following are the defaults:

require('my-theme').setup({
    -- NOTE: if your configuration sets vim.o.background in your configuration for Neovim,
    -- the following setting will do nothing, since it'll be overriden.
    theme = 'dark', -- String: 'dark' or 'light', determines the colorscheme used
    transparent = false, -- Boolean: Sets the background to transparent
    italics = {
        comments = true, -- Boolean: Italicizes comments
        keywords = true, -- Boolean: Italicizes keywords
        functions = true, -- Boolean: Italicizes functions
        strings = true, -- Boolean: Italicizes strings
        variables = true, -- Boolean: Italicizes variables
    },
    overrides = {}, -- A dictionary of group names, can be a function returning a dictionary or a table.
})
  • The colorscheme() function

This function can be used to set the colorscheme in your editor, however, if it doesn't work for you, you can always use vim.cmd.colorscheme('my-theme').

Specifics for Some Plugins

Bufferline.nvim

To use the theme with bufferline.nvim, you can use the following configuration:

require('bufferline').setup({
    highlights = require('my-theme').bufferline.highlights,
})

Contributing

Contributions are welcome, please open an issue if you encounter any bug or if you find any improvements are needed for the code, also feel free to open a PR.

Take a look at the Development Guide

License

MIT License