Skip to content

Commit

Permalink
docs: update
Browse files Browse the repository at this point in the history
  • Loading branch information
olimorris committed Jun 20, 2023
1 parent 0b53cb1 commit af81846
Showing 1 changed file with 47 additions and 46 deletions.
93 changes: 47 additions & 46 deletions doc/onedarkpro.nvim.txt
Original file line number Diff line number Diff line change
Expand Up @@ -333,7 +333,7 @@ customize or _override_ them:
})
<

You may also wish to extend existing highlight groups:
Existing highlight groups can also be extended:

>lua
require("onedarkpro").setup({
Expand All @@ -343,6 +343,9 @@ You may also wish to extend existing highlight groups:
})
<

In the example above, an underline style has been applied to the existing
`Comment` highlight group.


CREATING HIGHLIGHT GROUPS

Expand Down Expand Up @@ -404,6 +407,49 @@ Alternatively, by background color:
<


CONFIGURING STYLES ~


**Note**For a list of available styles, please refer to the |Neovim
documentation|
Styles can be applied to highlight groups:

>lua
require("onedarkpro").setup({
highlights = {
Comment = { italic = true },
Directory = { bold = true },
ErrorMsg = { italic = true, bold = true }
}
})
<

Within the theme, collections of highlight groups have been grouped together
into `styles`. For users who use monospaced fonts with nice italics, this can
go someway to enhancing the aesthetic of a theme with minimal effort. These
styles may be configured as shown in the example below:

>lua
require("onedarkpro").setup({
styles = {
types = "NONE",
methods = "NONE",
numbers = "NONE",
strings = "NONE",
comments = "italic",
keywords = "bold,italic",
constants = "NONE",
functions = "italic",
operators = "NONE",
variables = "NONE",
parameters = "NONE",
conditionals = "italic",
virtual_text = "NONE",
}
})
<


CONFIGURING FILETYPE HIGHLIGHTING ~


Expand Down Expand Up @@ -555,51 +601,6 @@ Or, all of the plugins can be disabled with a select few enabled:
<


CONFIGURING STYLES ~


**Note**See the |Neovim help| for a full list of styles.
Within the theme, collections of highlight groups have been grouped together
into `styles`. For users who use monospaced fonts with nice italics, this can
go someway to enhancing the aesthetic of a theme. These styles may be
configured as shown in the example below:

>lua
require("onedarkpro").setup({
styles = {
types = "NONE",
methods = "NONE",
numbers = "NONE",
strings = "NONE",
comments = "italic",
keywords = "bold,italic",
constants = "NONE",
functions = "italic",
operators = "NONE",
variables = "NONE",
parameters = "NONE",
conditionals = "italic",
virtual_text = "NONE",
}
})
<

Styles can also be applied manually to highlight groups:

>lua
require("onedarkpro").setup({
highlights = {
Comment = { italic = true },
Directory = { bold = true },
ErrorMsg = { italic = true, bold = true }
}
})
<


**Note**For a list of available styles, please refer to the |Neovim
documentation|

CONFIGURING OPTIONS ~

**Cursorline**
Expand Down

0 comments on commit af81846

Please sign in to comment.