Skip to content

This is a neovim theme, a tribute to all ordinary office workers who want to have a peaceful life~

License

Notifications You must be signed in to change notification settings

askfiy/killer-queen

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

README

Neovim Killer Queen Theme

Enjoy a peaceful life

The killer-queen theme is inspired by killer-queen, Kira Yoshikage's stand-in in "JoJo's Bizarre Adventure".

killer-queen is mainly based on pink, and paired with Kira Yoshikage's dark green tie and purple suit, it is full of lively atmosphere.

I hope that every user who uses this theme can get a cute pink big cat and live the peaceful life they dream of!

Install and use

Install via Lazy:

-- lazy
{
    "askfiy/killer-queen",
    priority = 100,
    config = function()
        vim.cmd([[colorscheme killer-queen]])
    end,
},

Default configuration

Default config, modify any option via setup():

require("killer-queen").setup({
    -- Do you have some UI with borders?
    -- Such as completion menu, floating terminal, etc.? If none of them have a border, try setting it to false
    is_border = true,
    -- Whether to enable background transparency
    transparent = false,
    -- Whether to apply the adapted plugin
    expands = {
        lazy = true,
        aerial = true,
        nvim_cmp = true,
        gitsigns = true,
        which_key = true,
        nvim_tree = true,
        lspconfig = true,
        telescope = true,
        bufferline = true,
        treesitter = true,
        vim_illuminate = true,
    },
    hooks = {
        before = function(conf, colors, utils) end,
        after = function(conf, colors, utils) end,
    },
})

Related functions

The plugin provides some utility functions:

require("killer-queen.utils")
   - set_hl(name, options)
   - bulk_set_hl(groups)

Example:

require("killer-queen.utils").set_hl("Normal", { fg = "#000000", bg = "#1E1E2E" })
require("killer-queen.utils").set_hl("Character", { link = "Constant" })
require("killer-queen.utils").bulk_set_hl({
    Normal = { fg = "#000000", bg = "#1E1E2E"},
    NormalFloat = { link = "Normal" },
    Cursor = { bg = "#0FE1EE", bold = true }
})

Hooks function

The plugin provides 2 hook functions, which are automatically executed before and after the color is applied:

hooks = {
    before = function(conf, colors, utils) end,
    after = function(conf, colors, utils) end,
}

Lualine integrated

This plugin integrates the lualine theme of the same name:

require("lualine").setup({
    options = {
        theme = "killer-queen"
    }
})

Extension

Extended plugin colors are in the expands directory.

lua/killer-queen/core/expands/

Also, any new PRs are welcome, as I'm not enthusiastic about plugin adaptation, so may need everyone's help to make it better..

License

This plugin is licensed under the MIT License. See the LICENSE file for details.

Contributing

Contributions are welcome! If you encounter a bug or want to enhance this plugin, feel free to open an issue or create a pull request.

About

This is a neovim theme, a tribute to all ordinary office workers who want to have a peaceful life~

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages