npm:northem-dark

README

A north-bluish, dark color palette.

Created for the clean- and minimal flat design pattern to achieve a optimal focus and readability for code syntax highlighting and UI. It consists of a total of sixteen, carefully selected, dimmed pastel colors for a eye-comfortable, but yet colorful ambiance.

This project is a more blue-tinged variation of the origin project Northem.

The color palette it divided into four named components to represent the different color effects.

Northem Dark Palette Overview

Northem Dark colors are numbered from northem-dark0 to northem-dark15 where each component contains a different amount of colors:

Dark Water northem-dark0 - northem-dark3
Light Wind northem-dark4 - northem-dark6
Ice northem-dark7 - northem-dark10
Rainbow northem-dark11 - northem-dark15

This naming convention allows an uncomplicated use for terminals and preserves the compatibility to similar projects like base16.

Usage

To show a list of all available Gulp tasks run gulp or gulp help.

CSS

The CSS specification supports the usage of primitive value types to define custom properties which can be used to create e.g. color variables.
Northem provides the template-css.scss template file to compile a northem-dark.css stylesheet.

The generated file contains all Northem Dark color variables prefixed with -- inside the :root pseudo-class.
The :root pseudo-class represents an element that is the root of the document.
This is always the HTML (<html>) element which allows to use the Northem Dark color variables for the whole document.

The northem-dark.css stylesheet can be compiled via Gulp:

npm install
gulp compile-css-template

Sass

Copy the northem-dark.scss file into your project and import it in your Sass files:

@import "northem-dark";

The .scss file extension is optional.

SassDoc

Northem Dark Sass sources are documented using the SassDoc documentation syntax which can be compiled to a HTML documentation via Gulp:

npm install
gulp sassdoc

The Sassdoc theme can be changed by editing the .sassdocrc configuration file.

LESSCSS

Copy the northem-dark.less file into your project and import it in your LESSCSS files:

@import "northem-dark";

Information about how the @import statement handles imports with different file extensions can be found in the official LESSCSS documentation.

KSS

Northem Dark LESSCSS sources are documented using the KSS documentation syntax.
Information about the generation of a styleguide can be found in the official KSS documentation.