Skip to content

Commit

Permalink
docs: Github Colorblind (Beta) docs init
Browse files Browse the repository at this point in the history
  • Loading branch information
ful1e5 committed Jan 10, 2022
1 parent 188ea91 commit 460902f
Show file tree
Hide file tree
Showing 2 changed files with 77 additions and 23 deletions.
28 changes: 22 additions & 6 deletions LUALINE.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,14 @@ require('lualine').setup {
![command](https://imgur.com/HGIYVSN.png)
![terminal](https://imgur.com/pEWjIJ8.png)

#### dimmed

![normal](https://imgur.com/R800MhA.png)
![insert](https://imgur.com/42M0X0O.png)
![visual](https://imgur.com/euIfZtW.png)
![command](https://imgur.com/E4tzBCD.png)
![terminal](https://imgur.com/RASnrFw.png)

#### dark_default

![normal](https://imgur.com/yHa1cK1.png)
Expand All @@ -68,13 +76,13 @@ require('lualine').setup {
![command](https://imgur.com/aLifoAv.png)
![terminal](https://imgur.com/Q7mG5m8.png)

#### dimmed
#### dark_colorblind

![normal](https://imgur.com/R800MhA.png)
![insert](https://imgur.com/42M0X0O.png)
![visual](https://imgur.com/euIfZtW.png)
![command](https://imgur.com/E4tzBCD.png)
![terminal](https://imgur.com/RASnrFw.png)
![normal](https://imgur.com/yHa1cK1.png)
![insert](https://imgur.com/mMX2364.png)
![visual](https://imgur.com/SNwhnph.png)
![command](https://imgur.com/aLifoAv.png)
![terminal](https://imgur.com/Q7mG5m8.png)

#### light

Expand All @@ -91,3 +99,11 @@ require('lualine').setup {
![visual](https://imgur.com/e3xYvfu.png)
![command](https://imgur.com/TrjrA3i.png)
![terminal](https://imgur.com/7ukHRhL.png)

#### light_colorblind

![normal](https://imgur.com/lwTCVXc.png)
![insert](https://imgur.com/zh9uPGS.png)
![visual](https://imgur.com/e3xYvfu.png)
![command](https://imgur.com/TrjrA3i.png)
![terminal](https://imgur.com/7ukHRhL.png)
72 changes: 55 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<p align="center">
<img src="https://imgur.com/OLRFrjD.png" alt="github-nvim-theme" />
<img src="https://imgur.com/S6SlCiV.png" alt="github-nvim-theme" />
</p>

### Status
Expand Down Expand Up @@ -65,7 +65,7 @@ require('github-theme').setup()
| msg_area_style | `NONE` | Highlight style for messages and cmdline (check `:help highlight-args` for options) |
| overrides | `function` | Override specific highlight groups. The function accept colors as argument. |
| sidebars | `{}` | Set a darker background on sidebar-like windows. For example: `{"qf", "vista_kind", "terminal", "packer"}` |
| theme_style | `dark` | Set theme variant (options: `dark`/`dark_default`/`dimmed`/`light`/`light_default`) |
| theme_style | `dark` | Set theme variant (options: `dark`/`dimmed`/`dark_default`/`dark_colorblind`/`light`/`light_default`/`light_colorblind`) |
| transparent | `false` | Enable this to disable setting the background color |
| variable_style | `NONE` | Highlight style for variables and identifiers (check `:help highlight-args` for options) |

Expand Down Expand Up @@ -166,9 +166,9 @@ set -as terminal-overrides ',*:Setulc=\E[58::2::%p1%{65536}%/%d::%p1%{256}%/%{25

## 📺 Screenshots

- Font: [Ubuntu Mono](https://design.ubuntu.com/font/)
- Font: [JetBrains Mono](https://www.jetbrains.com/lp/mono/)
- Terminal: [kitty](https://sw.kovidgoyal.net/kitty)
- Icon: [circles.nvim](https://github.com/projekt0n/circles.nvim)
- Icon: [nvim-web-devicons](https://github.com/kyazdani42/nvim-web-devicons)
- StatusLine: **Default**. [dotfiles/nvim/.config/nvim/lua/options.lua#L19-L30](https://github.com/ful1e5/dotfiles/blob/a2777f85b104622dd82f4adfc6ad032e3ff074bf/nvim/.config/nvim/lua/options.lua#L19-L30)
- dotfiles: [ful1e5/dotfiles/nvim](https://github.com/ful1e5/dotfiles/tree/main/nvim/.config/nvim)

Expand All @@ -190,7 +190,26 @@ require("github-theme").setup({
```

<p align="center">
<img src="https://imgur.com/wsST2ZB.png" alt="github_dark" />
<img src="https://imgur.com/XWxKWc8.png" alt="github_dark" />
</p>

#### Dimmed

```vim
" VimScript
colorscheme github_dimmed
```

```lua
-- Lua
require("github-theme").setup({
theme_style = "dimmed",
-- other config
})
```

<p align="center">
<img src="https://imgur.com/lMk4ifs.png" alt="github_dimmed" />
</p>

#### Dark Default
Expand All @@ -209,26 +228,26 @@ require("github-theme").setup({
```

<p align="center">
<img src="https://imgur.com/pNJDMft.png" alt="github_dark_default" />
<img src="https://imgur.com/ZfZcBGN.png" alt="github_dark_default" />
</p>

#### Dimmed
#### Dark Colorblind (Beta)

```vim
" VimScript
colorscheme github_dimmed
colorscheme github_dark_colorblind
```

```lua
-- Lua
require("github-theme").setup({
theme_style = "dimmed",
theme_style = "dark_colorblind",
-- other config
})
```

<p align="center">
<img src="https://imgur.com/LLp5qnT.png" alt="github_dimmed" />
<img src="https://imgur.com/OIXgRL4.png" alt="github_dark_colorblind" />
</p>

#### Light
Expand All @@ -247,7 +266,7 @@ require("github-theme").setup({
```

<p align="center">
<img src="https://imgur.com/yXEj746.png" alt="github_light" />
<img src="https://imgur.com/OPwBDI4.png" alt="github_light" />
</p>

#### Light Default
Expand All @@ -266,15 +285,34 @@ require("github-theme").setup({
```

<p align="center">
<img src="https://imgur.com/fykVFCr.png" alt="github_light_default" />
<img src="https://imgur.com/r9uPo5B.png" alt="github_light_default" />
</p>

#### Light Colorblind (Beta)

```vim
" VimScript
colorscheme github_light_colorblind
```

```lua
-- Lua
require("github-theme").setup({
theme_style = "light_colorblind",
-- other config
})
```

<p align="center">
<img src="https://imgur.com/fL4ZOUg.png" alt="github_light_colorblind" />
</p>

### Syntax Styles

#### Default

<p align="center">
<img src="https://imgur.com/GbemreO.png" alt="github_default_syntax" />
<img src="https://imgur.com/V0DsNa0.png" alt="github_default_syntax" />
</p>

#### Normal
Expand All @@ -299,7 +337,7 @@ require("github-theme").setup({
```

<p align="center">
<img src="https://imgur.com/qrJwUDb.png" alt="github_normal_syntax" />
<img src="https://imgur.com/aRDXkWp.png" alt="github_normal_syntax" />
</p>

#### Italic
Expand All @@ -324,7 +362,7 @@ require("github-theme").setup({
```

<p align="center">
<img src="https://imgur.com/TK6HEA4.png" alt="github_italic_syntax" />
<img src="https://imgur.com/5wr3dyQ.png" alt="github_italic_syntax" />
</p>

### Minimal config
Expand All @@ -343,13 +381,13 @@ require("github-theme").setup({
```

<p align="center">
<img src="https://imgur.com/TyaLR4n.png" alt="github_minimal" />
<img src="https://imgur.com/rAsEukW.png" alt="github_minimal" />
</p>

### Telescope

<p align="center">
<img src="https://imgur.com/vVFjJad.png" alt="github_telescope" />
<img src="https://imgur.com/XX7tixL.png" alt="github_telescope" />
</p>

## Contributing
Expand Down

0 comments on commit 460902f

Please sign in to comment.