diff --git a/.npmignore b/.npmignore new file mode 100644 index 0000000..1049f41 --- /dev/null +++ b/.npmignore @@ -0,0 +1,12 @@ +assets/** +src/** +.circleci/** +.github/** +.babelrc +.editorconfig +.gitignore +.npmrc +.stylelintrc.js +.travis.yml +gulpfile.babel.js +package-lock.json diff --git a/.npmrc b/.npmrc new file mode 100644 index 0000000..cffe8cd --- /dev/null +++ b/.npmrc @@ -0,0 +1 @@ +save-exact=true diff --git a/CHANGELOG.md b/CHANGELOG.md index 53e3691..31beb12 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,62 @@

-

+

--- + +# 0.1.0 +![Release Date: 2017-10-20](https://img.shields.io/badge/Release_Date-2017--10--20-88C0D0.svg?style=flat-square) [![Project Board](https://img.shields.io/badge/Project_Board-0.1.0-88C0D0.svg?style=flat-square)](https://github.com/arcticicestudio/nord-highlightjs/projects/2) [![Milestone](https://img.shields.io/badge/Milestone-0.1.0-88C0D0.svg?style=flat-square)](https://github.com/arcticicestudio/nord-highlightjs/milestone/1) + +## Feature + +Detailed information about features and install instructions can be found in the [README](https://github.com/arcticicestudio/nord-highlightjs/blob/develop/README.md#installation) and in the [project wiki](https://github.com/arcticicestudio/nord-highlightjs/wiki). + +

+ +❯ Implemented the main theme classes as documented in the official [style guide][hljs-style-guide] and [CSS classes reference][hljs-css-class-ref] and according to the [Nord Style Guidelines][nord-gh]. All sources are written with [Sass][sass]. The CSS selectors are separated as SCSS modules by the sections defined in the documentation. + +All [modules][nord-hljs-modules] are imported from the main [`nord.scss`][nord-hljs-scss] file. (@arcticicestudio, #1 in PR #3, 445f4f0e) + +❯ Implemented language-specific styles to adhere to the [Nord Style Guidelines][nord-gh]. (@arcticicestudio, #2 in PR #4 / #5 in PR #6, 2f74d76d / 15ffa3f9) + + +

Bash

+ +

C

+ +

C++

+ +

C#

+ +

CSS

+ +

diff

+ +

Go

+ +

HTML

+ +

Java

+ +

JOSN

+ +

PHP

+ +

Ruby

+ +

Rust

+ +

Scala

+ +

SQL

+ +

Swift

+ +

YAML

+ +[hljs-css-class-ref]: http://highlightjs.readthedocs.io/en/latest/css-classes-reference.html +[hljs-style-guide]:http://highlightjs.readthedocs.io/en/latest/style-guide.html +[nord-gh]: https://github.com/arcticicestudio/nord +[nord-hljs-scss]: https://github.com/arcticicestudio/nord-highlightjs/blob/develop/src/nord.scss +[nord-hljs-modules]: https://github.com/arcticicestudio/nord-highlightjs/tree/develop/src/modules +[sass]: http://sass-lang.com diff --git a/README.md b/README.md index fb8ea29..ed6b72f 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@

-

+

-

+

An arctic, north-bluish clean and elegant highlight.js theme.

@@ -11,6 +11,66 @@ Based on the Nord color pa --- +

Font: Source Code Pro 12px.

+ +## Getting started + +### Installation + +If your're using Git you can clone the repository to install the latest version: + +```sh +git clone https://github.com/arcticicestudio/nord-highlightjs +``` + +Otherwise download [the latest stable version][nord-latest-zip] or [`develop` branch][nord-develop-zip] as ZIP archive. + +### Usage + +Make sure to read the official documentation on [how to use highlight.js][hljs-docs-usage]. + +Copy the [`nord.css`][nord-dist-css] file to your desired directory and include the theme as stylesheet: + +```html + +``` + +### Screenshots + +

Bash

+ +

C

+ +

C++

+ +

C#

+ +

CSS

+ +

diff

+ +

Go

+ +

HTML

+ +

Java

+ +

JOSN

+ +

PHP

+ +

Ruby

+ +

Rust

+ +

Scala

+ +

SQL

+ +

Swift

+ +

YAML

+ ### Contribution Please report issues/bugs, feature requests and suggestions for improvements to the [issue tracker](https://github.com/arcticicestudio/nord-highlightjs/issues). @@ -24,4 +84,4 @@ Please report issues/bugs, feature requests and suggestions for improvements to [hljs-docs-usage]: https://highlightjs.org/usage [nord-develop-zip]: https://github.com/arcticicestudio/nord-highlightjs/archive/develop.zip [nord-dist-css]: https://github.com/arcticicestudio/nord-highlightjs/blob/develop/dist/nord.css -[nord-latest-zip]: https://github.com/arcticicestudio/nord-highlightjs/archive/v0.o.0.zip +[nord-latest-zip]: https://github.com/arcticicestudio/nord-highlightjs/archive/v0.1.0.zip diff --git a/assets/scrot-hero.png b/assets/scrot-hero.png new file mode 100644 index 0000000..bf0a545 Binary files /dev/null and b/assets/scrot-hero.png differ diff --git a/assets/scrot-lang-bash.png b/assets/scrot-lang-bash.png new file mode 100755 index 0000000..d995a6d Binary files /dev/null and b/assets/scrot-lang-bash.png differ diff --git a/assets/scrot-lang-c.png b/assets/scrot-lang-c.png new file mode 100755 index 0000000..f6a16c1 Binary files /dev/null and b/assets/scrot-lang-c.png differ diff --git a/assets/scrot-lang-cpp.png b/assets/scrot-lang-cpp.png new file mode 100755 index 0000000..eb9621e Binary files /dev/null and b/assets/scrot-lang-cpp.png differ diff --git a/assets/scrot-lang-cs.png b/assets/scrot-lang-cs.png new file mode 100755 index 0000000..a7dcdc4 Binary files /dev/null and b/assets/scrot-lang-cs.png differ diff --git a/assets/scrot-lang-css.png b/assets/scrot-lang-css.png new file mode 100755 index 0000000..8ee7494 Binary files /dev/null and b/assets/scrot-lang-css.png differ diff --git a/assets/scrot-lang-diff.png b/assets/scrot-lang-diff.png new file mode 100755 index 0000000..e5edabb Binary files /dev/null and b/assets/scrot-lang-diff.png differ diff --git a/assets/scrot-lang-go.png b/assets/scrot-lang-go.png new file mode 100755 index 0000000..fbb7ea9 Binary files /dev/null and b/assets/scrot-lang-go.png differ diff --git a/assets/scrot-lang-html.png b/assets/scrot-lang-html.png new file mode 100755 index 0000000..2a8d645 Binary files /dev/null and b/assets/scrot-lang-html.png differ diff --git a/assets/scrot-lang-java.png b/assets/scrot-lang-java.png new file mode 100644 index 0000000..48e78b7 Binary files /dev/null and b/assets/scrot-lang-java.png differ diff --git a/assets/scrot-lang-json.png b/assets/scrot-lang-json.png new file mode 100755 index 0000000..0d1483a Binary files /dev/null and b/assets/scrot-lang-json.png differ diff --git a/assets/scrot-lang-php.png b/assets/scrot-lang-php.png new file mode 100755 index 0000000..d4d8be6 Binary files /dev/null and b/assets/scrot-lang-php.png differ diff --git a/assets/scrot-lang-ruby.png b/assets/scrot-lang-ruby.png new file mode 100755 index 0000000..08529ca Binary files /dev/null and b/assets/scrot-lang-ruby.png differ diff --git a/assets/scrot-lang-rust.png b/assets/scrot-lang-rust.png new file mode 100755 index 0000000..31a4a15 Binary files /dev/null and b/assets/scrot-lang-rust.png differ diff --git a/assets/scrot-lang-scala.png b/assets/scrot-lang-scala.png new file mode 100755 index 0000000..0b05128 Binary files /dev/null and b/assets/scrot-lang-scala.png differ diff --git a/assets/scrot-lang-sql.png b/assets/scrot-lang-sql.png new file mode 100755 index 0000000..24adb98 Binary files /dev/null and b/assets/scrot-lang-sql.png differ diff --git a/assets/scrot-lang-swift.png b/assets/scrot-lang-swift.png new file mode 100755 index 0000000..ab6ebaa Binary files /dev/null and b/assets/scrot-lang-swift.png differ diff --git a/assets/scrot-lang-yaml.png b/assets/scrot-lang-yaml.png new file mode 100755 index 0000000..f1da896 Binary files /dev/null and b/assets/scrot-lang-yaml.png differ diff --git a/package-lock.json b/package-lock.json index 1b0469e..c1682a1 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "nord-highlightjs", - "version": "0.0.0", + "version": "0.1.0", "lockfileVersion": 1, "requires": true, "dependencies": { @@ -1031,7 +1031,7 @@ "dev": true, "requires": { "caniuse-lite": "1.0.30000748", - "electron-to-chromium": "1.3.26" + "electron-to-chromium": "1.3.27" } }, "bs-recipes": { @@ -1580,9 +1580,9 @@ "dev": true }, "electron-to-chromium": { - "version": "1.3.26", - "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.3.26.tgz", - "integrity": "sha1-mWQnKUhhp02cfIK5Jg6jAejALWY=", + "version": "1.3.27", + "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.3.27.tgz", + "integrity": "sha1-eOy4o5kGYYe7N07t412ccFZagD0=", "dev": true }, "emitter-steward": { diff --git a/package.json b/package.json index afbea38..d29d6f6 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "nord-highlightjs", "title": "Nord highlight.js", - "version": "0.0.0", + "version": "0.1.0", "description": "An arctic, north-bluish clean and elegant highlight.js theme.", "author": { "name": "Arctic Ice Studio", @@ -16,6 +16,7 @@ "bugs": { "url": "https://github.com/arcticicestudio/nord-highlightjs/issues" }, + "license": "(Apache-2.0 AND CC-BY-SA-4.0)", "keywords": [ "nord", "arctic", @@ -26,7 +27,10 @@ "highlight.js", "theme" ], - "license": "(Apache-2.0 AND CC-BY-SA-4.0)", + "main": "./dist/nord.css", + "scripts": { + "prepublish": "gulp clean && gulp compile" + }, "devDependencies": { "babel-core": "6.26.0", "babel-preset-env": "1.6.0", diff --git a/src/languages/abnf.scss b/src/languages/abnf.scss new file mode 100644 index 0000000..dcc1308 --- /dev/null +++ b/src/languages/abnf.scss @@ -0,0 +1,9 @@ +.abnf { + .hljs-attribute { + color: $nord8; + } + + .hljs-symbol { + color: $nord13; + } +} diff --git a/src/languages/apache.scss b/src/languages/apache.scss new file mode 100644 index 0000000..7a81434 --- /dev/null +++ b/src/languages/apache.scss @@ -0,0 +1,9 @@ +.apache { + .hljs-attribute { + color: $nord8; + } + + .hljs-section { + color: $nord9; + } +} diff --git a/src/languages/arduino.scss b/src/languages/arduino.scss new file mode 100644 index 0000000..441bb55 --- /dev/null +++ b/src/languages/arduino.scss @@ -0,0 +1,5 @@ +.arduino { + .hljs-built_in { + color: $nord8; + } +} diff --git a/src/languages/aspectj.scss b/src/languages/aspectj.scss new file mode 100644 index 0000000..1be459c --- /dev/null +++ b/src/languages/aspectj.scss @@ -0,0 +1,9 @@ +.aspectj { + .hljs-meta { + color: $nord12; + } + + > .hljs-title { + color: $nord8; + } +} diff --git a/src/languages/bnf.scss b/src/languages/bnf.scss new file mode 100644 index 0000000..c9e40b8 --- /dev/null +++ b/src/languages/bnf.scss @@ -0,0 +1,5 @@ +.bnf { + .hljs-attribute { + color: $nord7; + } +} diff --git a/src/languages/clojure.scss b/src/languages/clojure.scss new file mode 100644 index 0000000..69ff4a4 --- /dev/null +++ b/src/languages/clojure.scss @@ -0,0 +1,9 @@ +.clojure { + .hljs-name { + color: $nord8; + } + + .hljs-symbol { + color: $nord13; + } +} diff --git a/src/languages/coq.scss b/src/languages/coq.scss new file mode 100644 index 0000000..aa1af29 --- /dev/null +++ b/src/languages/coq.scss @@ -0,0 +1,5 @@ +.coq { + .hljs-built_in { + color: $nord8; + } +} diff --git a/src/languages/cpp.scss b/src/languages/cpp.scss new file mode 100644 index 0000000..5e3e519 --- /dev/null +++ b/src/languages/cpp.scss @@ -0,0 +1,5 @@ +.cpp { + .hljs-meta-string { + color: $nord7; + } +} diff --git a/src/languages/css.scss b/src/languages/css.scss new file mode 100644 index 0000000..5f6bd71 --- /dev/null +++ b/src/languages/css.scss @@ -0,0 +1,9 @@ +.css { + .hljs-built_in { + color: $nord8; + } + + .hljs-keyword { + color: $nord12; + } +} diff --git a/src/languages/diff.scss b/src/languages/diff.scss new file mode 100644 index 0000000..ace5262 --- /dev/null +++ b/src/languages/diff.scss @@ -0,0 +1,5 @@ +.diff { + .hljs-meta { + color: $nord7; + } +} diff --git a/src/languages/ebnf.scss b/src/languages/ebnf.scss new file mode 100644 index 0000000..c2fdc00 --- /dev/null +++ b/src/languages/ebnf.scss @@ -0,0 +1,5 @@ +.ebnf { + .hljs-attribute { + color: $nord7; + } +} diff --git a/src/languages/glsl.scss b/src/languages/glsl.scss new file mode 100644 index 0000000..9c75110 --- /dev/null +++ b/src/languages/glsl.scss @@ -0,0 +1,5 @@ +.glsl { + .hljs-built_in { + color: $nord8; + } +} diff --git a/src/languages/groovy.scss b/src/languages/groovy.scss new file mode 100644 index 0000000..d201998 --- /dev/null +++ b/src/languages/groovy.scss @@ -0,0 +1,5 @@ +.groovy { + .hljs-meta:not(:first-child) { + color: $nord12; + } +} diff --git a/src/languages/haxe.scss b/src/languages/haxe.scss new file mode 100644 index 0000000..064c465 --- /dev/null +++ b/src/languages/haxe.scss @@ -0,0 +1,5 @@ +.haxe { + .hljs-meta { + color: $nord12; + } +} diff --git a/src/languages/java.scss b/src/languages/java.scss new file mode 100644 index 0000000..67ca985 --- /dev/null +++ b/src/languages/java.scss @@ -0,0 +1,5 @@ +.java { + .hljs-meta { + color: $nord12; + } +} diff --git a/src/languages/ldif.scss b/src/languages/ldif.scss new file mode 100644 index 0000000..677c449 --- /dev/null +++ b/src/languages/ldif.scss @@ -0,0 +1,5 @@ +.ldif { + .hljs-attribute { + color: $nord7; + } +} diff --git a/src/languages/lisp.scss b/src/languages/lisp.scss new file mode 100644 index 0000000..3cb3dad --- /dev/null +++ b/src/languages/lisp.scss @@ -0,0 +1,5 @@ +.lisp { + .hljs-name { + color: $nord8; + } +} diff --git a/src/languages/lua.scss b/src/languages/lua.scss new file mode 100644 index 0000000..0892aeb --- /dev/null +++ b/src/languages/lua.scss @@ -0,0 +1,5 @@ +.lua { + .hljs-built_in { + color: $nord8; + } +} diff --git a/src/languages/moonscript.scss b/src/languages/moonscript.scss new file mode 100644 index 0000000..fe316f1 --- /dev/null +++ b/src/languages/moonscript.scss @@ -0,0 +1,5 @@ +.moonscript { + .hljs-built_in { + color: $nord8; + } +} diff --git a/src/languages/nginx.scss b/src/languages/nginx.scss new file mode 100644 index 0000000..9bdf03b --- /dev/null +++ b/src/languages/nginx.scss @@ -0,0 +1,9 @@ +.nginx { + .hljs-attribute { + color: $nord8; + } + + .hljs-section { + color: $nord10; + } +} diff --git a/src/languages/pf.scss b/src/languages/pf.scss new file mode 100644 index 0000000..1777c07 --- /dev/null +++ b/src/languages/pf.scss @@ -0,0 +1,5 @@ +.pf { + .hljs-built_in { + color: $nord8; + } +} diff --git a/src/languages/processing.scss b/src/languages/processing.scss new file mode 100644 index 0000000..e49398b --- /dev/null +++ b/src/languages/processing.scss @@ -0,0 +1,5 @@ +.processing { + .hljs-built_in { + color: $nord8; + } +} diff --git a/src/languages/scss.scss b/src/languages/scss.scss new file mode 100644 index 0000000..d22d02c --- /dev/null +++ b/src/languages/scss.scss @@ -0,0 +1,5 @@ +.scss { + .hljs-keyword { + color: $nord9; + } +} diff --git a/src/languages/stylus.scss b/src/languages/stylus.scss new file mode 100644 index 0000000..34d3bdb --- /dev/null +++ b/src/languages/stylus.scss @@ -0,0 +1,5 @@ +.stylus { + .hljs-keyword { + color: $nord9; + } +} diff --git a/src/languages/swift.scss b/src/languages/swift.scss new file mode 100644 index 0000000..ebcd190 --- /dev/null +++ b/src/languages/swift.scss @@ -0,0 +1,5 @@ +.swift { + .hljs-meta { + color: $nord12; + } +} diff --git a/src/languages/vim.scss b/src/languages/vim.scss new file mode 100644 index 0000000..73b150d --- /dev/null +++ b/src/languages/vim.scss @@ -0,0 +1,6 @@ +.vim { + .hljs-built_in { + color: $nord8; + font-style: italic; + } +} diff --git a/src/languages/yaml.scss b/src/languages/yaml.scss new file mode 100644 index 0000000..706cb6e --- /dev/null +++ b/src/languages/yaml.scss @@ -0,0 +1,5 @@ +.yaml { + .hljs-meta { + color: $nord12; + } +} diff --git a/src/modules/_base.scss b/src/modules/_base.scss new file mode 100644 index 0000000..cca9668 --- /dev/null +++ b/src/modules/_base.scss @@ -0,0 +1,11 @@ +.hljs { + display: block; + overflow-x: auto; + padding: 0.5em; + background: $nord0; +} + +.hljs, +.hljs-subst { + color: $nord4; +} diff --git a/src/modules/_css.scss b/src/modules/_css.scss new file mode 100644 index 0000000..558eedb --- /dev/null +++ b/src/modules/_css.scss @@ -0,0 +1,20 @@ +.hljs-selector-tag { + color: $nord9; +} + +.hljs-selector-id { + color: $nord7; + font-weight: bold; +} + +.hljs-selector-class { + color: $nord7; +} + +.hljs-selector-attr { + color: $nord7; +} + +.hljs-selector-pseudo { + color: $nord8; +} diff --git a/src/modules/_diff.scss b/src/modules/_diff.scss new file mode 100644 index 0000000..6a4e321 --- /dev/null +++ b/src/modules/_diff.scss @@ -0,0 +1,7 @@ +.hljs-addition { + background-color: transparentize($nord14, 0.5); +} + +.hljs-deletion { + background-color: transparentize($nord11, 0.5); +} diff --git a/src/modules/_general.scss b/src/modules/_general.scss new file mode 100644 index 0000000..6584e06 --- /dev/null +++ b/src/modules/_general.scss @@ -0,0 +1,42 @@ +.hljs-built_in, +.hljs-type { + color: $nord7; +} + +.hljs-class { + color: $nord7; +} + +.hljs-function { + color: $nord8; + + > .hljs-title { + color: $nord8; + } +} + +.hljs-keyword, +.hljs-literal, +.hljs-symbol { + color: $nord9; +} + +.hljs-number { + color: $nord15; +} + +.hljs-regexp { + color: $nord13; +} + +.hljs-string { + color: $nord14; +} + +.hljs-title { + color: $nord7; +} + +.hljs-params { + color: $nord4; +} diff --git a/src/modules/_markup.scss b/src/modules/_markup.scss new file mode 100644 index 0000000..efae4c4 --- /dev/null +++ b/src/modules/_markup.scss @@ -0,0 +1,29 @@ +.hljs-bullet { + color: $nord9; +} + +.hljs-code { + color: $nord7; +} + +.hljs-emphasis { + font-style: italic; +} + +.hljs-formula { + color: $nord7; +} + +.hljs-strong { + font-weight: bold; +} + +.hljs-link { + &:hover { + text-decoration: underline; + } +} + +.hljs-quote { + color: $nord3; +} diff --git a/src/modules/_meta.scss b/src/modules/_meta.scss new file mode 100644 index 0000000..24663ce --- /dev/null +++ b/src/modules/_meta.scss @@ -0,0 +1,16 @@ +.hljs-comment { + color: $nord3; +} + +.hljs-doctag { + color: $nord7; +} + +.hljs-meta, +.hljs-meta-keyword { + color: $nord10; +} + +.hljs-meta-string { + color: $nord14; +} diff --git a/src/modules/_tags_attributes_configs.scss b/src/modules/_tags_attributes_configs.scss new file mode 100644 index 0000000..d7d857c --- /dev/null +++ b/src/modules/_tags_attributes_configs.scss @@ -0,0 +1,27 @@ +.hljs-attr { + color: $nord7; +} + +.hljs-attribute { + color: $nord4; +} + +.hljs-builtin-name { + color: $nord9; +} + +.hljs-name { + color: $nord9; +} + +.hljs-section { + color: $nord8; +} + +.hljs-tag { + color: $nord9; +} + +.hljs-variable { + color: $nord4; +} diff --git a/src/modules/_templates.scss b/src/modules/_templates.scss new file mode 100644 index 0000000..a58b8f5 --- /dev/null +++ b/src/modules/_templates.scss @@ -0,0 +1,7 @@ +.hljs-template-variable { + color: $nord4; +} + +.hljs-template-tag { + color: $nord10; +} diff --git a/src/nord.scss b/src/nord.scss new file mode 100644 index 0000000..db0067a --- /dev/null +++ b/src/nord.scss @@ -0,0 +1,57 @@ +/* +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +title Nord highlight.js + +project nord-highlightjs + +version 0.1.0 + +repository https://github.com/arcticicestudio/nord-highlightjs + +author Arctic Ice Studio + +email development@arcticicestudio.com + +copyright Copyright (C) 2017 + +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +[References] +Nord + https://github.com/arcticicestudio/nord +highlight.js + http://highlightjs.readthedocs.io/en/latest/style-guide.html + http://highlightjs.readthedocs.io/en/latest/css-classes-reference.html +*/ + +@import "../node_modules/nord/src/sass/nord"; + +@import "modules/base"; +@import "modules/css"; +@import "modules/diff"; +@import "modules/general"; +@import "modules/markup"; +@import "modules/meta"; +@import "modules/_tags_attributes_configs"; +@import "modules/templates"; + +@import "languages/abnf"; +@import "languages/apache"; +@import "languages/arduino"; +@import "languages/aspectj"; +@import "languages/bnf"; +@import "languages/clojure"; +@import "languages/coq"; +@import "languages/cpp"; +@import "languages/css"; +@import "languages/diff"; +@import "languages/ebnf"; +@import "languages/glsl"; +@import "languages/groovy"; +@import "languages/haxe"; +@import "languages/java"; +@import "languages/ldif"; +@import "languages/lisp"; +@import "languages/lua"; +@import "languages/moonscript"; +@import "languages/nginx"; +@import "languages/pf"; +@import "languages/processing"; +@import "languages/scss"; +@import "languages/stylus"; +@import "languages/swift"; +@import "languages/vim"; +@import "languages/yaml";