Home

Awesome

Obscure

A dark Neovim theme written in Lua, inspired by the pastel palette mellow.nvim that I used for a long time.

๐Ÿ” Gallery

Lua

Screenshot of obscure theme Lua

TypeScript

Screenshot of obscure theme TypeScript

Astro

Screenshot of obscure theme Astro

Markdown

Screenshot of obscure theme Markdown

โœจ Features

๐Ÿ“ฆ Requirements

โšก๏ธ Installation

Install the theme using your preferred package manager, e.g. lazy:

{
  "killitar/obscure.nvim",
  lazy = false,
  priority = 1000,
  opts = {}
}

๐Ÿš€ Usage

Vim Script

colorscheme obscure

Lua

vim.cmd[[colorscheme obscure]]

โš™๏ธ Configuration

[!IMPORTANT] Set the configuration BEFORE loading the color scheme with colorscheme obscure.

<details> <summary>Default Options</summary> <!-- config:start -->
{
  transparent = false,
  terminal_colors = true,
  dim_inactive = true,
  styles = {
    keywords = { italic = true },
    identifiers = {},
    functions = {},
    variables = {},
    booleans = {},
    comments = { italic = true },
  },

  --- You can override specific highlights to use other groups or a hex color
  --- function will be called with a Highlights and ColorScheme table
  on_highlights = function(highlights, colors) end,

  plugins = {
    -- enable all plugins when not using lazy.nvim
    -- set to false to manually enable/disable plugins
    all = package.loaded.lazy == nil,
    -- uses your plugin manager to automatically enable needed plugins
    -- currently only lazy.nvim is supported
    auto = true,
    -- add any plugins here that you want to enable
    -- for all possible plugins, see:
    --   * https://github.com/killitar/obscure.nvim/tree/main/lua/obscure/groups
    -- flash = true,
  },
}

<!-- config:end --> </details>

๐Ÿช“ Overriding Colors & Highlight Groups

To configure a setting, you should pass that setting with the changed value following the structure of the default configuration.

require("obscure").setup({
    styles = {
        booleans = { italic = true, bold = true },
    },
    on_highlights = function(hl,c)
        hl.Comment = { fg = "#ffffff" }
        -- Or
        hl.Comment = { fg = c.orange }
    end
})

๐Ÿงต Extra

You can easily use the color palette for other plugins inside your Neovim configuration:

local colors = require("obscure.palettes").get_palette("obscure") -- pass in any of the config options as explained above

plugin.bg = colors.yellow

๐Ÿ‘ Acknowledgements