Skip to content

Commit

Permalink
chore(ci): auto generate docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ramojus authored and github-actions[bot] committed Jul 6, 2024
1 parent b18fef9 commit 1d4884d
Showing 1 changed file with 23 additions and 23 deletions.
46 changes: 23 additions & 23 deletions doc/mellifluous.txt
Original file line number Diff line number Diff line change
Expand Up @@ -41,11 +41,11 @@ Example with packer.nvim <https://github.com/wbthomason/packer.nvim>:

>lua
use({
'ramojus/mellifluous.nvim',
"ramojus/mellifluous.nvim",
-- version = "v0.*", -- uncomment for stable config (some features might be missed if/when v1 comes out)
config = function()
require'mellifluous'.setup({}) -- optional, see configuration section.
vim.cmd('colorscheme mellifluous')
require("mellifluous").setup({}) -- optional, see configuration section.
vim.cmd("colorscheme mellifluous")
end,
})
<
Expand All @@ -58,9 +58,9 @@ Here is an example with the default config. This is optional, and only relevant
parts of the config can be included.

>lua
require 'mellifluous'.setup({
require("mellifluous").setup({
dim_inactive = false,
color_set = 'mellifluous',
color_set = "mellifluous",
styles = { -- see :h attr-list for options. set {} for NONE, { option = true } for option
comments = { italic = true },
conditionals = {},
Expand Down Expand Up @@ -116,7 +116,7 @@ parts of the config can be included.

SETTING LIGHT THEME *mellifluous-configuration-setting-light-theme*

Set `vim.opt.background` to `'light'`. This will only work on color sets that
Set `vim.opt.background` to `"light"`. This will only work on color sets that
have light theme.


Expand All @@ -142,11 +142,11 @@ MELLIFLUOUS COLOR SET CONFIGURATION ~
Default config:

>lua
require 'mellifluous'.setup({
require("mellifluous").setup({
mellifluous = {
neutral = true, -- set this to false and bg_contrast to 'medium' for original mellifluous (then it was called meliora theme)
bg_contrast = 'medium' -- options: 'soft', 'medium', 'hard'
}
neutral = true, -- set this to false and bg_contrast to "medium" for original mellifluous (then it was called meliora theme)
bg_contrast = "medium", -- options: "soft", "medium", "hard"
},
})
<

Expand All @@ -156,7 +156,7 @@ OVERRIDING COLORS OF A COLOR SET ~
The following snippet shows where and which colors can be overridden:

>lua
require 'mellifluous'.setup({
require("mellifluous").setup({
<color_set_name> = { -- name any of the defined color sets
color_overrides = {
dark = { -- dark variant of the color set
Expand Down Expand Up @@ -186,23 +186,23 @@ The following snippet shows where and which colors can be overridden:
light = { -- light variant of the color set
-- same keys as in dark variant
},
}
}
},
},
})
<

For example, to override a color for the main keywords group in the dark
version of the mellifluous color set, one could do the following:

>lua
require 'mellifluous'.setup({
require("mellifluous").setup({
mellifluous = {
color_overrides = {
dark = {
main_keywords = '#e0e066'
}
}
}
main_keywords = "#e0e066",
},
},
},
})
<

Expand All @@ -213,10 +213,10 @@ The following snippet shows how highlight overrides can be defined for a
specific color set:

>lua
require 'mellifluous'.setup({
require("mellifluous").setup({
<color_set_name> = { -- name any of the defined color sets
-- config structure from here is the same as for global highlight overrides
}
},
})
<

Expand All @@ -237,15 +237,15 @@ The following snippet shows how global (for any color set) highlight overrides
can be defined:

>lua
require 'mellifluous'.setup({
require("mellifluous").setup({
highlight_overrides = {
dark = function(highlighter, colors) -- dark variant of the color set
-- set highlights here (using highlighter)
end,
light = function(highlighter, colors) -- light variant of the color set
-- set highlights here (using highlighter)
end,
}
},
})
<

Expand Down Expand Up @@ -328,7 +328,7 @@ functions (accessed with `:` operator):
- `with_saturation(val)`: returns color with specified saturation, where `val` can be from 0 to 100.

To create your own color that has the same functions available, use
`require('mellifluous.color').new(hex_value)` function.
`require("mellifluous.color").new(hex_value)` function.


==============================================================================
Expand Down

0 comments on commit 1d4884d

Please sign in to comment.