Skip to content

Commit e787d05

Browse files
committed
docs(readme): improve color palette and installation/usage instructions
1 parent fa0df86 commit e787d05

File tree

1 file changed

+7
-54
lines changed

1 file changed

+7
-54
lines changed

README.md

Lines changed: 7 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ Here is what the improved color palette looks like:
5454
- [Neovim](https://github.com/neovim/neovim) >=
5555
[0.7.2](https://github.com/neovim/neovim/releases/tag/v0.7.2)
5656

57-
## 📦 Installation
57+
## `📦` Installation
5858

5959
Install the theme with your preferred package manager, such as
6060
[folke/lazy.nvim](https://github.com/folke/lazy.nvim):
@@ -68,7 +68,7 @@ Install the theme with your preferred package manager, such as
6868
}
6969
```
7070

71-
## 🚀 Usage
71+
## `🚀` Usage
7272

7373
### Vim Script
7474

@@ -119,54 +119,7 @@ require('lualine').setup {
119119
let g:lightline = {'colorscheme': 'dullahan'}
120120
```
121121

122-
## ⚙️ Configuration
123-
124-
> ❗️ Set the configuration **BEFORE** loading the color scheme with `colorscheme dullahan`.
125-
126-
The theme offers four styles: [black](#black) and [white](#white)
127-
128-
[dullahan](https://github.com/PunGrumpy/dullahan.nvim) uses the default options,
129-
unless `setup` is explicitly called.
130-
131-
```lua
132-
require("dullahan").setup({
133-
-- your configuration comes here
134-
-- or leave it empty to use the default settings
135-
style = "storm", -- The theme comes in three styles, `black` (default), `gold` and `white`
136-
light_style = "white", -- The theme is used when the background is set to light
137-
transparent = false, -- Enable this to disable setting the background color
138-
terminal_colors = true, -- Configure the colors used when opening a `:terminal` in [Neovim](https://github.com/neovim/neovim)
139-
styles = {
140-
-- Style to be applied to different syntax groups
141-
-- Value is any valid attr-list value for `:help nvim_set_hl`
142-
comments = { italic = true },
143-
keywords = { italic = true },
144-
functions = {},
145-
variables = {},
146-
-- Background styles. Can be "dark", "transparent" or "normal"
147-
sidebars = "dark", -- style for sidebars, see below
148-
floats = "dark", -- style for floating windows
149-
},
150-
sidebars = { "qf", "help" }, -- Set a darker background on sidebar-like windows. For example: `["qf", "vista_kind", "terminal", "packer"]`
151-
day_brightness = 0.3, -- Adjusts the brightness of the colors of the **Day** style. Number between 0 and 1, from dull to vibrant colors
152-
hide_inactive_statusline = false, -- Enabling this option, will hide inactive statuslines and replace them with a thin border instead. Should work with the standard **StatusLine** and **LuaLine**.
153-
dim_inactive = false, -- dims inactive windows
154-
lualine_bold = false, -- When `true`, section headers in the lualine theme will be bold
155-
156-
--- You can override specific color groups to use other groups or a hex color
157-
--- function will be called with a ColorScheme table
158-
---@param colors ColorScheme
159-
on_colors = function(colors) end,
160-
161-
--- You can override specific highlights to use other groups or a hex color
162-
--- function will be called with a Highlights and ColorScheme table
163-
---@param highlights Highlights
164-
---@param colors ColorScheme
165-
on_highlights = function(highlights, colors) end,
166-
})
167-
```
168-
169-
## 🪓 Overriding Colors & Highlight Groups
122+
## `🪓` Overriding Colors & Highlight Groups
170123

171124
How the highlight groups are calculated:
172125

@@ -246,20 +199,20 @@ set -as terminal-overrides ',*:Smulx=\E[4::%p1%dm' # undercurl support
246199
set -as terminal-overrides ',*:Setulc=\E[58::2::%p1%{65536}%/%d::%p1%{256}%/%{255}%&%d::%p1%{255}%&%d%;m' # underscore colours - needs tmux-3.0
247200
```
248201

249-
## 🔥 Contributing
202+
## `🔥` Contributing
250203

251204
Pull requests are welcome and encouraged. For major changes, please open an
252205
issue first to discuss what you would like to change.
253206

254-
## 📖 Changelog
207+
## `📖` Changelog
255208

256209
See the [CHANGELOG.md](CHANGELOG.md) file for details.
257210

258-
## 📝 License
211+
## `📝` License
259212

260213
[Affero General Public License v3.0](LICENSE) for more information.
261214

262-
## 🙏 Credits
215+
## `🙏` Credits
263216

264217
<table>
265218
<tr>

0 commit comments

Comments
 (0)