docs: colorschemes comparison list added

related #298
projekt0n · Dec 4, 2023 · e248b62 · e248b62
1 parent 82fe04d
commit e248b62
Show file tree

Hide file tree

Showing 4 changed files with 66 additions and 42 deletions.
diff --git a/README.md b/README.md
@@ -23,6 +23,22 @@ or `:h github-theme-changelog` to receive updates on breaking changes and deprec
     **[github-theme-contrib](https://github.com/projekt0n/github-theme-contrib)**
     git repository and related code have been removed from this repository.
 
+## Supported Colorschemes & Comparisons
+
+| github-nvim-theme          | github-vscode-theme            | Github Web UI                   | Primer              |
+| :------------------------- | :----------------------------- | :------------------------------ | :------------------ |
+| github_dark                | Github Dark                    | -                               | -                   |
+| github_light               | Github Light                   | -                               | -                   |
+| github_dark_dimmed         | Github Dark Dimmed             | Dark dimmed                     | dark_dimmed         |
+| github_dark_default        | Github Dark Default            | Dark default                    | dark                |
+| github_light_default       | Github Light Default           | Light default                   | light               |
+| github_dark_high_contrast  | Github Dark High Contrast      | Dark high contrast              | dark_high_contrast  |
+| github_light_high_contrast | Github Light High Contrast     | Light high contrast             | light_high_contrast |
+| github_dark_colorblind     | Github Dark Colorblind (Beta)  | Dark Protanopia & Deuteranopia  | dark_colorblind     |
+| github_light_colorblind    | Github Light Colorblind (Beta) | Light Protanopia & Deuteranopia | light_colorblind    |
+| github_dark_tritanopia     | -                              | Dark Tritanopia                 | dark_tritanopia     |
+| github_light_tritanopia    | -                              | Light Tritanopia                | light_tritanopia    |
+
 ## Features
 
 -   Supports the latest Neovim>=0.5 features like Treesitter and LSP

diff --git a/Usage.md b/Usage.md
@@ -1,20 +1,23 @@
 ## Overview
 
 The Github Theme is a community-driven theme for Neovim, designed to support LSP (Language Server Protocol), Treesitter, and various plugins.
-It offers multiple themes, including colorblind-friendly options. Here are the available themes:
-
--   `github_dark`
--   `github_dark_colorblind`
--   `github_dark_default`
--   `github_dark_dimmed`
--   `github_dark_high_contrast`
--   `github_dark_tritanopia`
--   `github_dimmed`
--   `github_light`
--   `github_light_colorblind`
--   `github_light_default`
--   `github_light_high_contrast`
--   `github_light_tritanopia`
+It offers multiple themes, including colorblind-friendly options.
+
+Here are the available themes:
+
+| github-nvim-theme          | github-vscode-theme            | Github Web UI                   | Primer              |
+| :------------------------- | :----------------------------- | :------------------------------ | :------------------ |
+| github_dark                | Github Dark                    | -                               | -                   |
+| github_light               | Github Light                   | -                               | -                   |
+| github_dark_dimmed         | Github Dark Dimmed             | Dark dimmed                     | dark_dimmed         |
+| github_dark_default        | Github Dark Default            | Dark default                    | dark                |
+| github_light_default       | Github Light Default           | Light default                   | light               |
+| github_dark_high_contrast  | Github Dark High Contrast      | Dark high contrast              | dark_high_contrast  |
+| github_light_high_contrast | Github Light High Contrast     | Light high contrast             | light_high_contrast |
+| github_dark_colorblind     | Github Dark Colorblind (Beta)  | Dark Protanopia & Deuteranopia  | dark_colorblind     |
+| github_light_colorblind    | Github Light Colorblind (Beta) | Light Protanopia & Deuteranopia | light_colorblind    |
+| github_dark_tritanopia     | -                              | Dark Tritanopia                 | dark_tritanopia     |
+| github_light_tritanopia    | -                              | Light Tritanopia                | light_tritanopia    |
 
 ## Usage
 

diff --git a/doc/github-nvim-theme.txt b/doc/github-nvim-theme.txt
@@ -20,22 +20,39 @@ OVERVIEW                                          *github-nvim-theme-overview*
 
 The Github Theme is a community-driven theme for Neovim, designed to support
 LSP (Language Server Protocol), Treesitter, and various plugins. It offers
-multiple themes, including colorblind-friendly options. Here are the available
-themes:
-
-- `github_dark`
-- `github_dark_colorblind`
-- `github_dark_default`
-- `github_dark_dimmed`
-- `github_dark_high_contrast`
-- `github_dark_tritanopia`
-- `github_dimmed`
-- `github_light`
-- `github_light_colorblind`
-- `github_light_default`
-- `github_light_high_contrast`
-- `github_light_tritanopia`
+multiple themes, including colorblind-friendly options.
 
+Here are the available themes:
+
+  ---------------------------------------------------------------------------------------------
+  github-nvim-theme            github-vscode-theme   Github Web UI        Primer
+  ---------------------------- --------------------- -------------------- ---------------------
+  github_dark                  Github Dark           -                    -
+
+  github_light                 Github Light          -                    -
+
+  github_dark_dimmed           Github Dark Dimmed    Dark dimmed          dark_dimmed
+
+  github_dark_default          Github Dark Default   Dark default         dark
+
+  github_light_default         Github Light Default  Light default        light
+
+  github_dark_high_contrast    Github Dark High      Dark high contrast   dark_high_contrast
+                               Contrast                                   
+
+  github_light_high_contrast   Github Light High     Light high contrast  light_high_contrast
+                               Contrast                                   
+
+  github_dark_colorblind       Github Dark           Dark Protanopia &    dark_colorblind
+                               Colorblind (Beta)     Deuteranopia         
+
+  github_light_colorblind      Github Light          Light Protanopia &   light_colorblind
+                               Colorblind (Beta)     Deuteranopia         
+
+  github_dark_tritanopia       -                     Dark Tritanopia      dark_tritanopia
+
+  github_light_tritanopia      -                     Light Tritanopia     light_tritanopia
+  ---------------------------------------------------------------------------------------------
 
 USAGE                                                *github-nvim-theme-usage*
 

diff --git a/doc/gt_changelog.txt b/doc/gt_changelog.txt
@@ -12,19 +12,7 @@ Date: December 02, 2023
 Reimplemented the `*_default` colorschemes, previously deprecated in the
 |github-theme.changelog-23042023|.
 
-The updated colorscheme list now includes:
-
-- github_dark
-- github_dark_colorblind
-- github_dark_default               (Re-Implemented)
-- github_dark_dimmed
-- github_dark_high_contrast
-- github_dark_tritanopia
-- github_light
-- github_light_colorblind
-- github_light_default              (Re-Implemented)
-- github_light_high_contrast
-- github_light_tritanopia
+The updated colorscheme list on `:h github-nvim-theme-overview`