Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
nickgraffis authored Mar 24, 2021
1 parent 57b1277 commit 1933d2d
Showing 1 changed file with 33 additions and 11 deletions.
44 changes: 33 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,21 @@
![](https://img.shields.io/npm/v/tailwind-nord?style=flat)

<p align="center">
<a href="https://github.com/crumb1e/tailwind-nord">
<img src="https://draculatheme.com/static/icons/pack-1/045-dracula.svg" alt="Logo" width="150" />
</a>
<h1 align="center">&nbsp;+&nbsp;</h1>
<a href="">
<img src="https://cdn.worldvectorlogo.com/logos/tailwindcss.svg" width="150" />
</a>
<h1 align="center">Tailwind Nord</h1>
<h1 align="center">Tailwind Dracula</h1>
</p>

A super tiny tailwind plugin that enables the use of the [Nord color palette](https://www.nordtheme.com/).
A super tiny tailwind plugin that enables the use of the [Dracula colour palette](https://www.draculatheme.com/).

Made this mainly for myself, as I kept copying the Nord colours over manually. But hopefully it can save someone else 5 mins at the start of a project!
Hopefully this will give you some great dark colors in your next project, and save you 5 min of setting up custom colors.

## Installation

`npm i tailwind-nord`
`npm i tailwind-dracula`

## Usage

Expand All @@ -26,16 +24,40 @@ In your tailwind.config.js:

```js
plugins: [
require('tailwind-nord'),
require('tailwind-dracula'),
],
```

You now have access to the Nord theme anywhere you would use normal tailwind colours.
You now have access to the Dracula theme anywhere you would use normal tailwind colours.

```html
<div class="bg-nord0">
<p class="text-nord5">Hello, this is some text</p>
<div class="bg-buffy">
<p class="text-nosferatu ">I want to suck your blood...</p>
</div>
```

I've stuck to the colour names set in the Nord documentation to keep things simple. Check that out [here](https://www.nordtheme.com/docs/colors-and-palettes).
Color naming has two options (based on Dracula's names with some changes where needed):
* The color name option. <i>ie. darker, pink, purple</i>
* The vampire name option. <i>ie. dracula, vonCount, buffy</i>

## Color Palette

Palette | Hex | RGB | HSL | ![Color Picker Boxes](https://draculatheme.com/static/img/color-boxes/eyedropper.png)
--- | --- | --- | --- | ---
Darker/Nosferatu | `#282a36` | `40 42 54` | `231° 15% 18%` | ![Background Color](https://draculatheme.com/static/img/color-boxes/background.png)
Dark/Aro | `#44475a` | `68 71 90` | `232° 14% 31%` | ![Current Line Color](https://draculatheme.com/static/img/color-boxes/current_line.png)
Light/Cullen | `#f8f8f2` | `248 248 242` | `60° 30% 96%` | ![Foreground Color](https://draculatheme.com/static/img/color-boxes/foreground.png)
Blue/VonCount | `#6272a4` | `98 114 164` | `225° 27% 51%` | ![Comment Color](https://draculatheme.com/static/img/color-boxes/comment.png)
Cyan/VanHelsing | `#8be9fd` | `139 233 253` | `191° 97% 77%` | ![Cyan Color](https://draculatheme.com/static/img/color-boxes/cyan.png)
Green/Blade | `#50fa7b` | `80 250 123` | `135° 94% 65%` | ![Green Color](https://draculatheme.com/static/img/color-boxes/green.png)
Orange/Morbius | `#ffb86c` | `255 184 108` | `31° 100% 71%` | ![Orange Color](https://draculatheme.com/static/img/color-boxes/orange.png)
Pink/Buffy | `#ff79c6` | `255 121 198` | `326° 100% 74%` | ![Pink Color](https://draculatheme.com/static/img/color-boxes/pink.png)
Purple/Dracula | `#bd93f9` | `189 147 249` | `265° 89% 78%` | ![Purple Color](https://draculatheme.com/static/img/color-boxes/purple.png)
Red/Marcelin | `#ff5555` | `255 85 85` | `0° 100% 67%` | ![Red Color](https://draculatheme.com/static/img/color-boxes/red.png)
Yellow/Lincoln | `#f1fa8c` | `241 250 140` | `65° 92% 76%` | ![Yellow Color](https://draculatheme.com/static/img/color-boxes/yellow.png)

## Credits
[Dracula Theme](https://www.draculatheme.com/)<br />
[Dracula Theme GitHub](https://github.com/dracula/dracula-theme/blob/master/README.md)


0 comments on commit 1933d2d

Please sign in to comment.