Skip to content

Commit 037f265

Browse files
authored
Merge pull request #264 from projekt0n/changelog-typo
docs: Fixed changelog mistakes
2 parents f9e99e0 + 648e3b6 commit 037f265

File tree

2 files changed

+37
-34
lines changed

2 files changed

+37
-34
lines changed

CHANGELOG.md

+1
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1919
- Fixed Interactive mode in compiled colorscheme
2020
- #254 fixed
2121
- #257 fixed
22+
- #261 fixed
2223

2324
## [v1.0.0] - 19 May 2023
2425

doc/gt_changelog.txt

+36-34
Original file line numberDiff line numberDiff line change
@@ -26,26 +26,26 @@ any option.
2626
Date: April 23, 2023
2727

2828
The way to override color variables has been updated. You can now use the
29-
|specs| table to change colors for a specific colorscheme or for all of them
30-
with the |all| table. To override highlight groups, use the |groups| table in
29+
`specs` table to change colors for a specific colorscheme or for all of them
30+
with the `all` table. To override highlight groups, use the `groups` table in
3131
the configuration.
3232

3333
Some changes have been made to the names of the colorschemes. You can check
3434
the names of the colorschemes in the "colors" directory in the project root,
35-
or by using the *:colorscheme* vim command.
35+
or by using the `:colorscheme` vim command.
3636

3737
The deprecated colorschemes will no longer support any overriding highlight
3838
groups or color variables. The updated colorscheme list:
3939

40-
- |github_dark_default| -> |github_dark_high_contrast|
41-
- |github_dimmed| -> |github_dark_dimmed|
42-
- |github_light_default| -> |github_light_high_contrast|
43-
- |github_dark_tritanopia| -> New!
44-
- |github_light_tritanopia| -> New!
40+
- github_dark_default -> github_dark_high_contrast
41+
- github_dimmed -> github_dark_dimmed
42+
- github_light_default -> github_light_high_contrast
43+
- github_dark_tritanopia -> New!
44+
- github_light_tritanopia -> New!
4545

4646
The updated configuration keys are:
47-
- |colors| -> Use |specs| and |palettes| instead.
48-
- |overrides| -> Use |groups| instead.
47+
- colors -> Use `specs` and `palettes` instead.
48+
- overrides -> Use `groups` instead.
4949

5050
Example:
5151
>lua
@@ -93,31 +93,31 @@ Example:
9393
Date: April 13, 2023
9494

9595
The configuration for defining transparency, darkening windows, floating, and
96-
hiding elements has been moved to the *options* table.
96+
hiding elements has been moved to the `options` table.
9797

9898
The updated configuration keys are as follows:
99-
- |transparent| -> |options.transparent|
100-
- |hide_end_of_buffer| -> |options.hide_end_of_buffer|
101-
- |hide_inactive_statusline| -> |options.hide_nc_statusline|
102-
- |dark_float| -> |options.darken.floats|
103-
- |dark_sidebar| -> |options.darken.sidebars.enable|
104-
- |sidebars| -> |options.darken.sidebars.list|
99+
- transparent -> options.transparent
100+
- hide_end_of_buffer -> options.hide_end_of_buffer
101+
- hide_inactive_statusline -> options.hide_nc_statusline
102+
- dark_float -> options.darken.floats
103+
- dark_sidebar -> options.darken.sidebars.enable
104+
- sidebars -> options.darken.sidebars.list
105105

106106

107107

108108
*github-theme.changelog-12042023*
109109

110110
Date: April 12, 2023
111111

112-
The configuration for defining styles has been migrated to *options.styles*.
113-
As part of this migration, *msg_area_style* has been removed.
112+
The configuration for defining styles has been migrated to `options.styles`.
113+
As part of this migration, `msg_area_style` has been removed.
114114

115115
Here is the updated config keys:
116-
- |comment_style| -> |options.styles.comments|
117-
- |function_style| -> |options.styles.functions|
118-
- |keyword_style| -> |options.styles.keywords|
119-
- |variable_style| -> |options.styles.variables|
120-
- |msg_area_style| -> Removed.
116+
- comment_style -> options.styles.comments
117+
- function_style -> options.styles.functions
118+
- keyword_style -> options.styles.keywords
119+
- variable_style -> options.styles.variables
120+
- msg_area_style -> Removed.
121121

122122

123123

@@ -130,8 +130,9 @@ process of setting the colorscheme has been changed, It is important to note
130130
that the configuration may undergo further changes in the future, and will be
131131
described in the latest changelogs and documentation.
132132

133-
Additionally, the currently used colorscheme palettes within the *palette*
134-
module have been given the prefix |'github_'|.
133+
Additionally, the currently used colorscheme palettes within the
134+
`github-theme.palette.*` module have been given the prefix
135+
`github-theme.palette.github_*`.
135136

136137
Old approach for setting the theme:
137138
>lua
@@ -158,12 +159,12 @@ New approach for setting the theme:
158159
Date: April 06, 2023
159160

160161
The secondary method of assigning configuration variables using
161-
|'vim.g.github_*'| is now considered deprecated. Instead, it is recommended to
162-
use the |'require("github-theme").setup({...})'| function to assign
162+
`'vim.g.github_*'` is now considered deprecated. Instead, it is recommended to
163+
use the `'require("github-theme").setup({...})'` function to assign
163164
configurations.
164165

165166
Any references to the deprecated modules and options can be found in the
166-
documentation located at `:h gt_deprecated.txt`.
167+
documentation located at `:h github-theme.deprecated`.
167168

168169

169170

@@ -174,14 +175,14 @@ Date: January 03, 2023
174175
PR: https://github.com/projekt0n/github-nvim-theme/pull/222
175176

176177
I (ful1e5) wanted to let you know that we now have support for new treesitter
177-
highlighting groups, thanks to a contribution from |@luisiacc|. If you are
178+
highlighting groups, thanks to a contribution from `@luisiacc`. If you are
178179
using an older version of treesitter, please switch to the `v0.7` release tag,
179180
which is the last version for you to take advantage of the old treesitter
180181
highlights. We will continue to develop and support these new highlighting
181182
groups going forward.
182183

183184
In addition, I am planning a major refactor of the codebase to make it
184-
compatible with |Neovim-0.9| and will be starting a discussion on GitHub soon.
185+
compatible with `Neovim-0.9` and will be starting a discussion on GitHub soon.
185186
To ensure that the community is aware of any major changes before they are
186187
implemented, I will provide advance warning before any potentially breaking
187188
changes are pushed to upstream.
@@ -202,17 +203,18 @@ URL: https://github.com/projekt0n/github-theme-contrib
202203
*github-theme.changelog-13122021*
203204

204205
Date: December 13, 2021
206+
205207
PR: https://github.com/projekt0n/github-nvim-theme/pull/148
206208

207209
This small change is made for differentiate the inactive Statusline and
208210
tabline from the background.
209211

210212
A list of changes that have been made:
211213

212-
- Minimal look deprecated for |lualine|. This deprecation is related to
214+
- Minimal look deprecated for `lualine` plugin. This deprecation is related to
213215
`hide_inactive_statusline` option. This means the theme will not force the
214-
|underline| style to inactive lualine.
215-
- Native lualine theme support terminal highlights |terminal-config|
216+
`underline` style to inactive lualine.
217+
- Native lualine theme support terminal highlights `terminal-config`
216218
- Inactive tabline highlights got enhanced.
217219

218220

0 commit comments

Comments
 (0)