Skip to content

Commit

Permalink
Docs(palette): Add preview and palette.toml for prev_gen (#104)
Browse files Browse the repository at this point in the history
* Docs(palette): Add preview and palette.toml for prev_gen

* Move palette image
  • Loading branch information
Vibhav201 authored Feb 8, 2024
1 parent 36f6edc commit 0657b08
Show file tree
Hide file tree
Showing 4 changed files with 218 additions and 6 deletions.
15 changes: 9 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# 🌒 Nordic

[![Tests](https://github.com/AlexvZyl/nordic.nvim/workflows/Tests/badge.svg)](https://github.com/AlexvZyl/nordic.nvim/actions?workflow=Tests)
[![Tests](https://github.com/AlexvZyl/nordic.nvim/workflows/Tests/badge.svg)](https://github.com/AlexvZyl/nordic.nvim/actions?workflow=Tests)

A Neovim colorscheme based on [Nord](https://www.nordtheme.com/), but Aurora > Frost. The idea behind this colorscheme is to use Nord, but add some darker colors and use Aurora more prominently than Nord themes usually do. This ends up creating a colorscheme that is soft on the eyes.
A Neovim colorscheme based on [Nord](https://www.nordtheme.com/), but Aurora > Frost. The idea behind this colorscheme is to use Nord, but add some darker colors and use Aurora more prominently than Nord themes usually do. This ends up creating a colorscheme that is soft on the eyes.

If there is anything that does not seem right, even if it is a very small highlight, please let me know with an issue or PR!

#### 💡 Looking for Maintainers

Currently looking for maintainers. If you are keen, head on over to [the discussion](https://github.com/AlexvZyl/nordic.nvim/discussions/96).
Currently looking for maintainers. If you are keen, head on over to [the discussion](https://github.com/AlexvZyl/nordic.nvim/discussions/96).

# 📷 Showcase

Expand All @@ -19,7 +19,9 @@ Currently looking for maintainers. If you are keen, head on over to [the discus

# 🎨 Palette

For the list of colors/palette, see [this file](https://github.com/AlexvZyl/nordic.nvim/blob/main/lua/nordic/colors/nordic.lua). Some extra colors and use cases are generated in [this file](https://github.com/AlexvZyl/nordic.nvim/blob/main/lua/nordic/colors/init.lua).
For the list of colors/palette, see [this file](https://github.com/AlexvZyl/nordic.nvim/blob/main/lua/nordic/colors/nordic.lua). Some extra colors and use cases are generated in [this file](https://github.com/AlexvZyl/nordic.nvim/blob/main/lua/nordic/colors/init.lua).

![image](assets/palette.png)

# 📦 Installation

Expand Down Expand Up @@ -82,7 +84,7 @@ local palette = require 'nordic.colors'

# ⚙️ Configuration

Nordic will use the default values, unless `setup` is called. Below is the default configuration.
Nordic will use the default values, unless `setup` is called. Below is the default configuration.

```lua
require 'nordic' .setup {
Expand Down Expand Up @@ -152,14 +154,15 @@ require 'nordic' .setup {

# 🗒️ Supported Plugins and Platforms

For the list of supported plugins, please take a look at [this directory](https://github.com/AlexvZyl/nordic.nvim/tree/main/lua/nordic/groups/integrations). For the list of supported platforms, please take a look at [this directory](https://github.com/AlexvZyl/nordic.nvim/tree/main/platforms).
For the list of supported plugins, please take a look at [this directory](https://github.com/AlexvZyl/nordic.nvim/tree/main/lua/nordic/groups/integrations). For the list of supported platforms, please take a look at [this directory](https://github.com/AlexvZyl/nordic.nvim/tree/main/platforms).

I do not personally use all of the platforms and plugins in the list, so if something is not right, or you have a suggestion, please open a PR!

# 🎙️ Acknowledgements

- [folke/tokyonight](https://github.com/folke/tokyonight.nvim) served as an excellent example and template to create a Neovim theme.
- [Dotfiles](https://github.com/AlexvZyl/.dotfiles) used in the screenshots.
- [Aonodensetsu/prev_gen](https://github.com/Aonodensetsu/prev_gen) was used to create the palette preview.

</br>

Expand Down
Binary file added assets/palette.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
156 changes: 156 additions & 0 deletions assets/palette.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
53 changes: 53 additions & 0 deletions assets/palette.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
#
palette = [
[
["#191D24", "black0" ],
["#1E222A", "black1" ],
["#222630", "black2" ],
["#242933", "gray0" ],
["#2E3440", "gray1" ],
["#3B4252", "gray2" ],
["#434C5E", "gray3" ]
],
[
["#C0C8D8", "white_alt"],
["#BBC3D4", "white0" ],
["#D8DEE9", "white1" ],
["#E5E9F0", "white2" ],
["#ECEFF4", "white3" ],
["#60728A", "gray5" ],
["#4C566A", "gray4" ]
],
[
["#5E81AC", "blue0" ],
["#8FBCBB", "cyan" ],
["#BF616A", "red" ],
["#D08770", "orange" ],
["#EBCB8B", "yellow" ],
["#A3BE8C", "green" ],
["#B48EAD", "magenta" ]
],
[
["#81A1C1", "blue1" ],
["#9FC6C5", "cyan_b" ],
["#C5727A", "red_b" ],
["#D79784", "orange_b" ],
["#EFD49F", "yellow_b" ],
["#B1C89D", "green_b" ],
["#BE9DB8", "magenta_b" ]
],
[
["#88C0D0", "blue2" ],
["#80B3B2", "cyan_d" ],
["#B74E58", "red_d" ],
["#CB775D", "orange_d" ],
["#E7C173", "yellow_d" ],
["#97B67C", "green_d" ],
["#A97EA1", "magenta_d" ]
]
]

[settings]
fileName = "Nordic"
nameSize = 34
hexSize = 24

0 comments on commit 0657b08

Please sign in to comment.