Skip to content

Commit

Permalink
docs: fix broken/outdated overrides example
Browse files Browse the repository at this point in the history
Fixes: #340, #341
  • Loading branch information
tmillr committed Jul 16, 2024
1 parent 52a9d4c commit a24960a
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 14 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- fix(config): `options.darken.floats` is not used (#345)
- fix(compiler): consider entire config when hashing (#350) (related-to #262, #340, #341)
- fix(compiler): always write hash to filesystem when compilation occurs incl. when `require('github-theme').compile()` is called directly (#350)
- Fixed #340 and #341 (broken/outdated `overrides` example in docs)

## [v1.0.2] - 03 May 2023

Expand Down
14 changes: 7 additions & 7 deletions Usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,27 +57,27 @@ The individual components, such as [palettes][palette], [specs][spec], and [grou
according to your preferences.

```lua
local override = require('github-theme').override
override.palettes({
local override = require('github-theme.override')
override.palettes = {
github_dark = {
red = '#ff0000',
},
github_light = {
comment = '#636e7b',
},
})
override.specs({
}
override.specs = {
github_dark = {
syntax = {
keyword = 'magenta'
}
}
})
override.groups({
}
override.groups = {
all = {
IncSearch = { bg = 'palette.cyan' },
},
})
}
```

Overrides for [palettes][palette] and [specs][spec] are defined per style. The purpose of overriding these components is to change the colors used in
Expand Down
14 changes: 7 additions & 7 deletions doc/github-nvim-theme.txt
Original file line number Diff line number Diff line change
Expand Up @@ -97,27 +97,27 @@ The individual components, such as |github-nvim-theme-palettes|,
separately to customize the theme according to your preferences.

>lua
local override = require('github-theme').override
override.palettes({
local override = require('github-theme.override')
override.palettes = {
github_dark = {
red = '#ff0000',
},
github_light = {
comment = '#636e7b',
},
})
override.specs({
}
override.specs = {
github_dark = {
syntax = {
keyword = 'magenta'
}
}
})
override.groups({
}
override.groups = {
all = {
IncSearch = { bg = 'palette.cyan' },
},
})
}
<

Overrides for |github-nvim-theme-palettes| and |github-nvim-theme-specs| are
Expand Down

0 comments on commit a24960a

Please sign in to comment.