*solarized.nvim.txt*         For NVIM v0.9.4        Last change: 2024 March 28

==============================================================================
Table of Contents                           *solarized.nvim-table-of-contents*

  - Features                                         |solarized.nvim-features|
  - Requirements                                 |solarized.nvim-requirements|
  - Install from package manager |solarized.nvim-install-from-package-manager|
  - Manual Installation                   |solarized.nvim-manual-installation|
  - Help                                                 |solarized.nvim-help|
  - Commands                                         |solarized.nvim-commands|
  - Default Config                             |solarized.nvim-default-config|
  - Config Themes                               |solarized.nvim-config-themes|
  - Config Styles                               |solarized.nvim-config-styles|
  - Config Highlights                       |solarized.nvim-config-highlights|
  - Config Colors                               |solarized.nvim-config-colors|
  - Config Enables                             |solarized.nvim-config-enables|
  - Config Autocmd                             |solarized.nvim-config-autocmd|
  - Lualine                                           |solarized.nvim-lualine|
  - Barbecue                                         |solarized.nvim-barbecue|
  - Api                                                   |solarized.nvim-api|
  - Contributing                                 |solarized.nvim-contributing|
  - Designed by                                   |solarized.nvim-designed-by|
  - Credits and Reference 🎉     |solarized.nvim-credits-and-reference-🎉|
1. Links                                                |solarized.nvim-links|

Solarized is a sixteen color palette (eight monotones, eight accent colors)
designed for use with terminal and gui applications. click here to learn more
<https://ethanschoonover.com/solarized/>

- |solarized.nvim-features|
- |solarized.nvim-requirements|
- |solarized.nvim-install-from-package-manager|
- |solarized.nvim-manual-installation|
- |solarized.nvim-help|
- |solarized.nvim-commands|
- |solarized.nvim-default-config|
- |solarized.nvim-config-themes|
- |solarized.nvim-config-styles|
- |solarized.nvim-config-highlights|
- |solarized.nvim-config-colors|
- |solarized.nvim-config-enables|
- |solarized.nvim-config-autocmd|
- |solarized.nvim-lualine|
- |solarized.nvim-barbecue|
- |solarized.nvim-api|
    - |solarized.nvim-get-colors|
    - |solarized.nvim-color-utils|
    - |solarized.nvim-how-to-get-color-shades|
    - |solarized.nvim-how-to-get-color-tints|
- |solarized.nvim-contributing|
- |solarized.nvim-designed-by|
- |solarized.nvim-credits-and-reference-🎉|


FEATURES                                             *solarized.nvim-features*

- Support for Treesitter
- Support for Semantic highlight
- Customizability: styles, colors and highlights can all be modified
- Plugin compatibility
- Provides users with the option to enable or disable highlight groups
- Selenized color palette


REQUIREMENTS                                     *solarized.nvim-requirements*

Before using the Solarized Colorscheme, please make sure you have the following
requirements installed:

- `Neovim v0.9.1+`
- nvim-treesitter <https://github.com/nvim-treesitter/nvim-treesitter>


INSTALL FROM PACKAGE MANAGER     *solarized.nvim-install-from-package-manager*

Download using your preferred package manager.

lazy <https://github.com/folke/lazy.nvim>

>lua
      {
        'maxmx03/solarized.nvim',
        lazy = false,
        priority = 1000,
        config = function()
          vim.o.background = 'dark' -- or 'light'
    
          vim.cmd.colorscheme 'solarized'
        end,
      },
<

packer <https://github.com/wbthomason/packer.nvim>

>lua
    use {
        'maxmx03/solarized.nvim',
        config = function()
          vim.o.background = 'dark' -- or 'light'
    
          vim.cmd.colorscheme 'solarized'
        end
    }
<


MANUAL INSTALLATION                       *solarized.nvim-manual-installation*

To manually install Solarized, follow these steps:

1. Download the stable release of Solarized.
2. Extract the contents of the release.
3. Locate the following folders in the extracted files: `after`, `colors`,
`lua`, `plugin`.
4. Copy these folders to the `~/.config/nvim` directory.


HELP                                                     *solarized.nvim-help*

Use |solarized.nvim.txt| to get some help


COMMANDS                                             *solarized.nvim-commands*

- `:Solarized colors` - Display the Solarized palette in a new buffer
- `:Solarized zen`- Removes highlight colors, emphasizing important code segments.


DEFAULT CONFIG                                 *solarized.nvim-default-config*

>lua
    vim.o.background = 'dark'
    
    -- default config
    require('solarized').setup({
        transparent = false, -- enable transparent background
        palette = 'solarized', -- or selenized
        styles = {
          comments = {},
          functions = {},
          variables = {},
          numbers = {},
          constants = {},
          parameters = {},
          keywords = {},
          types = {},
        },
        enables = {
          bufferline = true,
          cmp = true,
          diagnostic = true,
          dashboard = true,
          editor = true,
          gitsign = true,
          hop = true,
          indentblankline = true,
          lsp = true,
          lspsaga = true,
          navic = true,
          neogit = true,
          neotree = true,
          notify = true,
          noice = true,
          semantic = true,
          syntax = true,
          telescope = true,
          tree = true,
          treesitter = true,
          todo = true,
          whichkey = true,
          mini = true,
        },
        highlights = {},
        colors = {},
        theme = 'default', -- or 'neo'
        autocmd = true,
    })
    
    vim.cmd.colorscheme = 'solarized' -- or selenized
<


CONFIG THEMES                                   *solarized.nvim-config-themes*

Solarized offers two themes: the default Solarized theme and Neo. These themes
provide different visual styles to enhance your experience.

>lua
    require('solarized').setup({
        theme = 'neo' -- or comment to use solarized default theme.
    })
<


CONFIG STYLES                                   *solarized.nvim-config-styles*

The `styles` config allows you to customize the style of a highlight group.

>lua
    require('solarized').setup({
        styles = {
          comments = { italic = true, bold = false },
          functions = { italic = true },
          variables = { italic = false },
        }
    })
<


CONFIG HIGHLIGHTS                           *solarized.nvim-config-highlights*

The `highlights` config allows you to customize the highlights groups.

example:

>lua
    require('solarized').setup {
        highlights = function (colors, colorhelper)
            local darken = colorhelper.darken
            local lighten = colorhelper.lighten
            local blend = colorhelper.blend
    
            return {
                LineNr = { fg = c.base1, bg = c.base02 },
                CursorLineNr = { bg = c.base02 },
                CursorLine = { bg = c.base02 },
                Function = { italic = false },
                Visual = { bg = c.cyan },
            }
        end
    }
<


CONFIG COLORS                                   *solarized.nvim-config-colors*

The `colors` config allows you to extend or modify the color palette used by
solarized.

example:

>lua
    require('solarized').setup {
        colors = function(colors, colorhelper)
            local darken = colorhelper.darken
            local lighten = colorhelper.lighten
            local blend = colorhelper.blend
    
            return {
                fg = '#fff', -- output: #ffffff
                bg = darken(colors.base03, 100)
            }
        end,
        highlights = function(colors)
            return {
                Normal = { fg = colors.fg, bg = colors.bg }
            }
        end
    }
<


CONFIG ENABLES                                 *solarized.nvim-config-enables*

The enables config allows you to enable or disable solarized support for spefic
plugins or neovim’s default highlights

example:

>lua
    require('solarized').setup {
      enables = {
          editor = true,
          syntax = true,
    
          -- PLUGINS
          bufferline = true,
          cmp = false, -- disabled
          diagnostic = true,
          indentblankline = true,
          lsp = true,
          lspsaga = false, -- disabled
          navic = true,
          semantic = true,
          telescope = true,
          tree = false, -- disabled
          treesitter = true,
        },
        highlights = {
            -- your implementation of nvim-tree
            -- your implementation of cmp
            -- your implementation of lspsaga
        }
    }
<


CONFIG AUTOCMD                                 *solarized.nvim-config-autocmd*

This option enhances highlighting by enabling Solarized’s autocmd feature.


LUALINE                                               *solarized.nvim-lualine*

>lua
    require('lualine').setup {
      options = {
        theme = 'solarized',
        disabled_filetypes = {
            'NvimTree',
        },
      },
    }
<

Alternatively, to utilize Lualine’s Solarized theme:

>lua
    require('lualine').setup {
        options = {
          theme = require('lualine.themes.solarized')
        }
    }
<

To use the Solarized theme showcased in the screenshot for Lualine click here
<https://github.com/maxmx03/solarized.nvim/discussions/50>


BARBECUE                                             *solarized.nvim-barbecue*

>lua
    require('barbecue').setup {
      theme = 'solarized',
    }
<


API                                                       *solarized.nvim-api*

You can utilize useful functions to customize your Neovim plugins.


GET COLORS ~

>lua
    local palette = require('solarized.palette')
    local colors = palette.get_colors()
<


COLOR UTILS ~

>lua
    local color = require('solarized.utils.colors')
    
    -- Convert a hex color code to RGB
    color.hex_to_rgb('#ffffff')
    
    -- Darken a color by a specified percentage
    color.darken('#ffffff', 100)
    
    -- Lighten a color by a specified percentage
    color.lighten('#000000', 100)
    
    -- Blend two colors with a specified ratio
    color.blend('#ffffff', '#000000', 0.15)
<


HOW TO GET COLOR SHADES ~

>lua
    local darken = require('solarized.utils.colors').darken
    local colors = require('solarized.palette').get_colors()
    for i = 1, 10, 1 do
      local shade = darken(colors.blue, i * 10)
    
      print(shade)
    end
<


HOW TO GET COLOR TINTS ~

>lua
    local lighten = require('solarized.utils.colors').lighten
    
    for i = 1, 10, 1 do
      local tints = lighten(colors.blue, i * 10)
    
      print(tints)
    end
<


CONTRIBUTING                                     *solarized.nvim-contributing*

Pull requests are welcome and appreciated.


DESIGNED BY                                       *solarized.nvim-designed-by*

<https://github.com/altercation>

Ethan Schoonover


CREDITS AND REFERENCE 🎉         *solarized.nvim-credits-and-reference-🎉*

- onedarkpro <https://github.com/olimorris/onedarkpro.nvim>
- solarized-vim <https://github.com/altercation/vim-colors-solarized>
- tokyonight <https://github.com/folke/tokyonight.nvim>

<https://github.com/glepnir>

==============================================================================
1. Links                                                *solarized.nvim-links*

1. *solarized*: https://github.com/maxmx03/solarized.nvim/assets/50273941/3c2ffda7-9efb-46f4-ad82-7dfd257dda39
2. *Ethan Schoonover*: https://github.com/altercation.png?size=100
3. *Raphael*: https://github.com/glepnir.png?size=100

Generated by panvimdoc <https://github.com/kdheepak/panvimdoc>

vim:tw=78:ts=8:noet:ft=help:norl:
