Skip to content

Commit

Permalink
Merge branch 'release/0.1.0'
Browse files Browse the repository at this point in the history
  • Loading branch information
arcticicestudio committed Sep 4, 2016
2 parents 6dc9b05 + a83318f commit 6d0b65d
Show file tree
Hide file tree
Showing 35 changed files with 226,565 additions and 4 deletions.
12 changes: 12 additions & 0 deletions .sassdocrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"dest": "./build/documentation/sassdoc",
"package": "package.json",
"groups": {
"polarnight": "Polar Night",
"snowstorm": "Snow Storm",
"frost": "Frost",
"aurora": "Aurora"
},
"theme": "flippant",
"verbose": true
}
45 changes: 44 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1 +1,44 @@
![Nord](https://raw.githubusercontent.com/arcticicestudio/nord/develop/src/assets/nord-logo-banner.svg)
<p align="center"><img src="https://raw.githubusercontent.com/arcticicestudio/nord/develop/src/assets/nord-logo-banner.svg"/></p>

# 0.1.0 (2016-09-04)
![Nord Palette Overview](https://raw.githubusercontent.com/arcticicestudio/nord/develop/src/assets/nord-overview.svg)

## Features
### <img src="http://sass-lang.com/favicon.ico" width=16 height=16 /> Sass
- Implemented the `nord.scss` stylesheet
- Implemented the `template-css.scss` stylesheet.
This template can be compiled to a `nord.css` stylesheet via [Gulp][gulp]:
```sh
npm install
gulp compile-css-template
```

#### <img src="http://sassdoc.com/favicon.png" width=16 height=16 /> Sassdoc
Nord Sass sources are documented using the [Sassdoc][sassdoc] documentation syntax which can be compiled to a HTML documentation via [Gulp][gulp]:
```sh
npm install
gulp sassdoc
```
The Sassdoc theme can be changed by editing the `.sassdocrc` configuration file.

### <img src="http://lesscss.org/public/ico/favicon.ico" width=16 height=16 /> LESSCSS
- Implemented the `nord.less` stylesheet

#### KSS
Nord LESSCSS sources are documented using the [KSS](http://warpspire.com/kss) documentation syntax.
Information about the generation of a styleguide can be found in the [official KSS documentation](http://warpspire.com/kss/styleguides).

### ![][icon-color-swatch] Color Swatches
Added various native color palette files:
- **Adobe Photoshop**: `nord.aco` (binary)
- **Adobe Swatch Exchange**: `nord.ase` (binary)
- **Gpick Palette**: `nord.gpa` (binary)
- **GIMP/Inkscape/CinePaint/Krita Palette**:`nord.gpl`
- **Alias/WaveFront Material**: nord.mtl`
# 0.0.0 (2016-09-04)
**Project Initialization**
[icon-color-swatch]: https://raw.githubusercontent.com/arcticicestudio/nord/develop/src/assets/icon-color-swatch.svg
[sassdoc]: http://sassdoc.com
[gulp]: http://gulpjs.com
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Copy the `nord.scss` file into your project and import it in your Sass files:
The `.scss` file extension is optional.

#### Sassdoc
Nord is documented using the [Sassdoc](http://sassdoc.com) documentation syntax which can be compiled to a HTML documentation via [Gulp][gulp]:
Nord Sass sources are documented using the [Sassdoc](http://sassdoc.com) documentation syntax which can be compiled to a HTML documentation via [Gulp][gulp]:
```sh
npm install
gulp sassdoc
Expand All @@ -59,7 +59,7 @@ Copy the `nord.less` file into your project and import it in your LESSCSS files:
Information about how the `@import` statement handles imports with different file extensions can be found in the [official LESSCSS documentation](http://lesscss.org/features/#import-directives-feature).

#### KSS
Nord is documented using the [KSS](http://warpspire.com/kss) documentation syntax.
Nord LESSCSS sources are documented using the [KSS](http://warpspire.com/kss) documentation syntax.
Information about the generation of a styleguide can be found in the [official KSS documentation](http://warpspire.com/kss/styleguides).

### <img src="https://raw.githubusercontent.com/arcticicestudio/nord/develop/src/assets/icon-color-swatch.svg"/> Color Swatches
Expand All @@ -74,10 +74,11 @@ Nord is available in various native formats:
[![Nord Atom Syntax](https://raw.githubusercontent.com/arcticicestudio/nord/develop/src/assets/banner-nord-atom-syntax.svg)](https://atom.io/themes/nord-atom-syntax)
[![Nord Atom UI](https://raw.githubusercontent.com/arcticicestudio/nord/develop/src/assets/banner-nord-atom-ui.svg)](https://atom.io/themes/nord-atom-ui)
[![Nord IntelliJ IDEA Syntax](https://raw.githubusercontent.com/arcticicestudio/nord/develop/src/assets/banner-nord-intellij-idea-syntax.svg)](https://github.com/arcticicestudio/nord-intellij-idea-syntax)
[![Nord Notepad++](https://raw.githubusercontent.com/arcticicestudio/nord/develop/src/assets/banner-nord-notepadplusplus.svg)](https://github.com/arcticicestudio/nord-notepadplusplus)
[![Nord Vim](https://raw.githubusercontent.com/arcticicestudio/nord/develop/src/assets/banner-nord-vim.svg)](https://github.com/arcticicestudio/nord-vim)

## Development
[![Changelog](https://img.shields.io/badge/Changelog-v0.0.0-blue.svg)](https://github.com/arcticicestudio/nord/blob/v0.0.0/CHANGELOG.md)
[![Changelog](https://img.shields.io/badge/Changelog-v0.1.0-blue.svg)](https://github.com/arcticicestudio/nord/blob/v0.1.0/CHANGELOG.md)

### Workflow
This project follows the [gitflow](http://nvie.com/posts/a-successful-git-branching-model) branching model.
Expand Down
142 changes: 142 additions & 0 deletions gulpfile.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,142 @@
/*
+++++++++++++++++++++++++++++++++++++++++++
title Project Gulp File +
project nord +
version 0.1.0 +
author Arctic Ice Studio +
email [email protected] +
copyright Copyright (C) 2016 +
+++++++++++++++++++++++++++++++++++++++++++
[Index]
> Configuration
> Imports
> Tasks
clean
clean-css
clean-documentation
compile-css-template
default
sassdoc
[References]
Gulp
(http://gulpjs.com)
npmjs
(https://www.npmjs.com)
*/

"use strict";
/*+---------------+
+ Configuration +
+---------------+*/
var config = {
project: {
id: "nord",
name: "Nord",
version: "0.1.0",
repository: "https://github.com/arcticicestudio/nord",
author: "Arctic Ice Studio",
email: "[email protected]"
},
build: {
base: "./build",
css: "./build/css",
sassdoc: "./build/documentation/sassdoc"
},
src: {
sass: "./src/sass"
},
tasks: {
compilation: {
sass: {
extensions: {
input: ["scss"],
output: "css"
},
options: {
indentedSyntax: false,
indentType: "space",
indentWidth: 2,
linefeed: "lf",
outputStyle: "expanded",
precision: 5,
sourceComments: false
}
}
}
}
}

/*+---------+
+ Imports +
+---------+*/
var del = require("del");
var fs = require("fs");
var gulp = require("gulp-help")(require("gulp"));
var gulputil = require("gulp-util");
var path = require("path");
var plumber = require("gulp-plumber");
var rename = require("gulp-rename");
var sass = require("gulp-sass");
var sassdoc = require("sassdoc");

/*+-------+
+ Tasks +
+-------+*/
/**
* Cleans the whole build folder.
*
* @since 0.1.0
*/
gulp.task("clean", function() {
del(config.build.base);
});

/**
* Cleans the CSS build folder.
*
* @since 0.1.0
*/
gulp.task("clean-css", function(){
del(config.build.css);
});

/**
* Cleans the documentation build folder.
*
* @since 0.1.0
*/
gulp.task("clean-documentation", function(){
del(config.build.sassdoc);
});

/**
* Compiles the Sass CSS template.
*
* @since 0.1.0
*/
gulp.task("compile-css-template", function() {
return gulp.src(path.join(config.src.sass, "/template-css." + config.tasks.compilation.sass.extensions.input))
.pipe(plumber())
.pipe(sass(config.tasks.compilation.sass.options).on("error", sass.logError))
.pipe(rename("/nord." + config.tasks.compilation.sass.extensions.output))
.pipe(gulp.dest(config.build.css))
});

/**
* Shows the help.
*
* @since 0.1.0
*/
gulp.task("default", ["help"]);

/**
* Creates the Sassdoc documentation.
*
* @since 0.1.0
*/
gulp.task("sassdoc", function () {
return gulp.src(path.join(config.src.sass, "/**/*." + config.tasks.compilation.sass.extensions.input))
.pipe(sassdoc())
});
39 changes: 39 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
{
"name": "nord",
"title": "Nord",
"version": "0.1.0",
"description": "A arctic, north-bluish color palette",
"author": {
"name": "Arctic Ice Studio",
"email": "[email protected]",
"url": "http://arcticicestudio.com"
},
"homepage": "https://github.com/arcticicestudio/nord",
"repository": {
"type": "git",
"url": "git+https://github.com/arcticicestudio/nord.git"
},
"bugs": {
"url": "https://github.com/arcticicestudio/nord/issues"
},
"license" : "(GPL-3.0 AND CC-BY-SA-4.0)",
"keywords": [
"nord",
"arctic",
"north",
"bluish",
"ui",
"syntax"
],
"devDependencies": {
"del": "2.2.2",
"gulp": "3.9.1",
"gulp-help": "1.6.1",
"gulp-plumber": "1.1.0",
"gulp-rename": "1.2.2",
"gulp-sass": "2.3.2",
"gulp-util": "3.0.7",
"sassdoc": "2.1.20",
"sassdoc-theme-flippant": "0.1.0"
}
}
Loading

0 comments on commit 6d0b65d

Please sign in to comment.