Skip to content

Commit

Permalink
docs: update, fix typo, minor improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
tmillr committed Jun 6, 2023
1 parent 85e550f commit cb601d8
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 17 deletions.
27 changes: 12 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -227,9 +227,9 @@ require('github-theme').setup({
dim_inactive = false, -- Non focused panes set to alternative background
module_default = true, -- Default enable value for modules
styles = { -- Style to be applied to different syntax groups
comments = 'italic', -- Value is any valid attr-list value `:help attr-list`
comments = 'NONE', -- Value is any valid attr-list value `:help attr-list`
functions = 'NONE',
keywords = 'italic',
keywords = 'NONE',
variables = 'NONE',
conditionals = 'NONE',
constants = 'NONE',
Expand Down Expand Up @@ -263,15 +263,13 @@ require('github-theme').setup({
vim.cmd('colorscheme github_dark')
```

If you would like to change any of the default options above you only have to define the options that change. If an
option is not present in your options table the default option will be used. For example if changing the styles of
certain syntax is the only desired change then your options table would look like:
If you would like to change any of the default options above, simply specify the options that you'd like to change. Unspecified options will use their default value. For example, if you only wanted to change the styles of certain syntax items:

```lua
require('github-theme').setup({
options = {
styles = {
comments = 'NONE',
comments = 'italic',
keywords = 'bold',
types = 'italic,bold',
}
Expand Down Expand Up @@ -303,14 +301,11 @@ local palettes = {
all = {
-- Each palette defines these colors:
-- black, gray, blue, green, magenta, pink, red, white, yellow, cyan

--
-- These colors have 2 shades: base, and bright
--
-- Defining just a color defines it's base color
red = {
base = '#ff0000'
},

-- Passing a string sets the base
red = '#ff0000',
},
github_dark = {
-- Defining multiple shades is done by passing a table
Expand Down Expand Up @@ -371,7 +366,7 @@ local specs = {
}

-- Groups are the highlight group definitions. The keys of this table are the name of the highlight
-- groups that will be overridden. The value is a table with the following values:
-- groups that will be overridden. The value is a table with the following keys:
-- - fg, bg, style, sp, link,
--
-- Just like `spec` groups support templates. This time the template is based on a spec object.
Expand Down Expand Up @@ -601,8 +596,10 @@ Set your airline colorscheme with `:AirlineThemes` vim command.

## Syntax highlight groups

This section will help you determine what highlight group is being applied to a piece of syntax. These sections will
output the highlight group for the value under the cursor.
This section will help you determine what highlight group is being applied to a piece of syntax. These methods
show which highlight group(s) is in use at the current screen position of the cursor (under the cursor).

> **Note** On Neovim v0.9.0 and later, you can use the command `:Inspect`, or the Lua function `vim.show_pos()`.
#### Treesitter highlighting

Expand Down
2 changes: 1 addition & 1 deletion Usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -410,7 +410,7 @@ Current list of modules are:
### Neovim specific modules

The following modules are enabled by default only when on neovim, `diagnostic`, `native_lsp`, `treesitter`. These modules are part of the core neovim experience and
are liked to by other modules. This also means that they will still be enabled when setting `module_default` to `false`.
are linked to by other modules. This also means that they will still be enabled when setting `module_default` to `false`.

### Extended modules

Expand Down
2 changes: 1 addition & 1 deletion doc/github-nvim-theme.txt
Original file line number Diff line number Diff line change
Expand Up @@ -509,7 +509,7 @@ NEOVIM SPECIFIC MODULES ~

The following modules are enabled by default only when on neovim, `diagnostic`,
`native_lsp`, `treesitter`. These modules are part of the core neovim
experience and are liked to by other modules. This also means that they will
experience and are linked to by other modules. This also means that they will
still be enabled when setting `module_default` to `false`.


Expand Down

0 comments on commit cb601d8

Please sign in to comment.