Redesign the documentation and add as GitBook

The documentation was partially outdated for both style guidelines and topicality and has been adapted to the latest design guidelines and redesign in #19. It will be deployed as "GitHub Page" (1) to the "gh-pages" branch. References: (1) https://pages.github.com GH-25
nordtheme · Jan 7, 2018 · 651e457 · 651e457
1 parent 775161e
commit 651e457
Show file tree

Hide file tree

Showing 20 changed files with 320 additions and 56 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -1,6 +1,6 @@
 /*
- * Copyright (c) 2016-present Arctic Ice Studio <[email protected]>
- * Copyright (c) 2016-present Sven Greb <[email protected]>
+ * Copyright (c) 2017-present Arctic Ice Studio <[email protected]>
+ * Copyright (c) 2017-present Sven Greb <[email protected]>
  *
  * Project:    Nord Hyper
  * Repository: https://github.com/arcticicestudio/nord-hyper

diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1 @@
+* text eol=lf
diff --git a/.gitignore b/.gitignore
@@ -10,3 +10,8 @@ pids
 *.pid
 *.seed
 *.pid.lock
+
+# +-------------------+
+# + Project Strcuture +
+# +-------------------+
+build/
diff --git a/.travis.yml b/.travis.yml
@@ -1,5 +1,5 @@
-# Copyright (c) 2016-present Arctic Ice Studio <[email protected]>
-# Copyright (c) 2016-present Sven Greb <[email protected]>
+# Copyright (c) 2017-present Arctic Ice Studio <[email protected]>
+# Copyright (c) 2017-present Sven Greb <[email protected]>
 
 # Project:    Nord Hyper
 # Repository: https://github.com/arcticicestudio/nord-hyper

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,16 +5,23 @@
 ---
 
 # 0.4.0
-*2017-03-14*
+
+![Release Date: 2017-03-14](https://img.shields.io/badge/Release_Date-2017--03--14-88C0D0.svg?style=flat-square) [![Project Board](https://img.shields.io/badge/Project_Board-0.4.0-88C0D0.svg?style=flat-square)](https://github.com/arcticicestudio/nord-hyper/projects/6) [![Milestone](https://img.shields.io/badge/Milestone-0.4.0-88C0D0.svg?style=flat-square)](https://github.com/arcticicestudio/nord-hyper/milestone/5)
+
 ## Improvements
+
 ❯ The `cursorColor` configuration is now respected to use the user defined color before the theme color. (@berkin, PR #8, bc73116f)
 
 # 0.3.0
-*2017-03-09*
+
+![Release Date: 2017-03-09](https://img.shields.io/badge/Release_Date-2017--03--09-88C0D0.svg?style=flat-square) [![Project Board](https://img.shields.io/badge/Project_Board-0.3.0-88C0D0.svg?style=flat-square)](https://github.com/arcticicestudio/nord-hyper/projects/5) [![Milestone](https://img.shields.io/badge/Milestone-0.3.0-88C0D0.svg?style=flat-square)](https://github.com/arcticicestudio/nord-hyper/milestone/4)
+
 ## Features
-### [Configurations][readme-configuration]
-❯ Added a configuration to set the [cursor blinking](https://github.com/arcticicestudio/nord-hyper#cursor-blinking).  
-The default value is `true` to enable the non-obtrusive cursor blinking feature. (@zovt, #7, 27820cf8)  
+
+### Configurations
+
+❯ Added a configuration to set the [cursor blinking][gh-readme-config-cursor-blinking]. The default value is `true` to enable the non-obtrusive cursor blinking feature. (#7, @zovt, 27820cf8)
+
 ```js
 module.exports = {
   config: {
@@ -30,43 +37,69 @@ module.exports = {
 <p align="center"><img src="https://raw.githubusercontent.com/arcticicestudio/nord-hyper/develop/assets/scrcast-feature-cursor-blink.gif"/></p>
 
 # 0.2.0
-*2017-03-08*
+
+![Release Date: 2017-03-08](https://img.shields.io/badge/Release_Date-2017--03--08-88C0D0.svg?style=flat-square) [![Project Board](https://img.shields.io/badge/Project_Board-0.2.0-88C0D0.svg?style=flat-square)](https://github.com/arcticicestudio/nord-hyper/projects/4) [![Milestone](https://img.shields.io/badge/Milestone-0.2.0-88C0D0.svg?style=flat-square)](https://github.com/arcticicestudio/nord-hyper/milestone/3)
+
 ## Features
-### Plugin Support 
-❯ Added optimized style integration for the [hyper-statusline](https://www.npmjs.com/package/hyper-statusline) plugin. (@arcticicestudio, #6, 8ec6ad5d)
 
-<p align="center"><img src="https://cloud.githubusercontent.com/assets/7836623/23712413/2a10b672-0423-11e7-854d-cb68e3e2a04c.png"/><br><strong>Hovered</strong><br><img src="https://cloud.githubusercontent.com/assets/7836623/23712434/3705d98e-0423-11e7-941a-7d0abc1b859d.png"/><br><strong>Hover transition</strong><img src="https://cloud.githubusercontent.com/assets/7836623/23712581/a40366f0-0423-11e7-80bd-e680808227aa.gif"/></p>
+### Plugin Support
+
+❯ Added optimized style integration for the [hyper-statusline][npm-hyper-statusline] plugin. (#6, 8ec6ad5d)
+
+<p align="center"><img src="https://cloud.githubusercontent.com/assets/7836623/23712413/2a10b672-0423-11e7-854d-cb68e3e2a04c.png"/></p>
+
+<p align="center"><strong>Hovered</strong><br><img src="https://cloud.githubusercontent.com/assets/7836623/23712434/3705d98e-0423-11e7-941a-7d0abc1b859d.png"/></p>
+
+<p align="center"><strong>Hover transition</strong><img src="https://cloud.githubusercontent.com/assets/7836623/23712581/a40366f0-0423-11e7-80bd-e680808227aa.gif"/></p>
 
 # 0.1.1
-*2017-02-21*
+
+![Release Date: 2017-02-21](https://img.shields.io/badge/Release_Date-2017--02--21-88C0D0.svg?style=flat-square) [![Project Board](https://img.shields.io/badge/Project_Board-0.1.1-88C0D0.svg?style=flat-square)](https://github.com/arcticicestudio/nord-hyper/projects/3) [![Milestone](https://img.shields.io/badge/Milestone-0.1.1-88C0D0.svg?style=flat-square)](https://github.com/arcticicestudio/nord-hyper/milestone/2)
+
 ## Improvements
+
 ### Continuous Integration Builds
-❯ [Circle CI](https://circleci.com/gh/arcticicestudio/nord-hyper) builds are running against the latest [Node](https://nodejs.org) `6.x.x` version now
-❯ [Travis-CI](https://travis-ci.org/arcticicestudio/nord-hyper) builds are running against the latest [Node](https://nodejs.org) `6.x.x` and `4.x.x` versions now
+
+❯ [Circle CI][ci-circle] builds are running against the latest supported [Node.js][nodejs] versions
+
+❯ [Travis-CI][ci-travisci] builds are running against the latest supported [Node.js][nodejs] versions
 
 ## Bug Fixes
-❯ Fixed the order of the `cursorShape`, `fontSize` and `fontFamily` configuration attributes to prevent overriding of the defined `~/.hyper.js` user configs with the theme defaults. (@kepbod, #2 #3, 45e8e9c3)
+
+❯ Fixed the order of the `cursorShape`, `fontSize` and `fontFamily` configuration attributes to prevent overriding of the defined `~/.hyper.js` user configs with the theme defaults. (#2 and #3, @kepbod, 45e8e9c3)
 
 ### Documentation
-❯ Fixed the keymaps to open- and reload the `~/.hyper.js` config file. (@kepbod, #2, d1604716)
+
+❯ Fixed the keymaps to open- and reload the `~/.hyper.js` config file. (#2, @kepbod, d1604716)
 
 # 0.1.0
-*2017-02-19*
+
+![Release Date: 2017-02-19](https://img.shields.io/badge/Release_Date-2017--02--19-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-hyper/projects/2) [![Milestone](https://img.shields.io/badge/Milestone-0.1.0-88C0D0.svg?style=flat-square)](https://github.com/arcticicestudio/nord-hyper/milestone/1)
+
 <img src="https://www.npmjs.com/static/images/touch-icons/apple-touch-icon-60x60.png" width=16 height=16/> **Initial npm module release version!**
 
 ## Features
-A complete list of all implemented features can be found in the [README](https://github.com/arcticicestudio/nord-hyper/blob/develop/README.md#features) section.
 
-❯ Implemented the main `index.js` script theme file [`index.js`](https://github.com/arcticicestudio/nord-hyper/blob/develop/index.js). (@arcticicestudio, #1, b1fde294)
+A complete list of all implemented features can be found in the [README][gh-readme-features] section.
+
+❯ Implemented the main `index.js` script theme file [`index.js`][gh-index.js]. (#1, b1fde294)
 
 <p align="center"><img src="https://raw.githubusercontent.com/arcticicestudio/nord-hyper/develop/assets/scrot-top.png"/></p>
 
 <p align="center"><img src="https://raw.githubusercontent.com/arcticicestudio/nord-hyper/develop/assets/scrot-feature-tabs.png"/></p>
 
-Detailed information about features and install instructions can be found in the [README](https://github.com/arcticicestudio/nord-hyper/blob/develop/README.md#installation) and in the [project wiki](https://github.com/arcticicestudio/nord-hyper/wiki).
+Detailed information about features and install instructions can be found in the [README][gh-readme-installation] and in the [project wiki][gh-wiki].
+
+# Project Initialization
 
-# 0.0.0
-*2017-02-19*
-**Project Initialization**
+![Release Date: 2017-02-19](https://img.shields.io/badge/Release_Date-2017--02--19-88C0D0.svg?style=flat-square)
 
-[readme-configuration]: https://github.com/arcticicestudio/nord-hyper#configuration
+[ci-circleci]: https://circleci.com/gh/arcticicestudio/nord-hyper
+[ci-travisci]: https://travis-ci.org/arcticicestudio/nord-hyper
+[gh-readme-config-cursor-blinking]: https://github.com/arcticicestudio/nord-hyper#cursor-blinking
+[gh-readme-features]: https://github.com/arcticicestudio/nord-hyper/blob/develop/README.md#features
+[gh-readme-installation]: https://github.com/arcticicestudio/nord-hyper/blob/develop/README.md#installation
+[gh-index.js]: https://github.com/arcticicestudio/nord-hyper/blob/develop/index.js
+[gh-wiki]: https://github.com/arcticicestudio/nord-hyper/wiki
+[nodejs]: https://nodejs.org
+[npm-hyper-statusline]: https://www.npmjs.com/package/hyper-statusline
diff --git a/README.md b/README.md
@@ -2,51 +2,75 @@
 
 <p align="center"><img src="https://cdn.travis-ci.org/images/favicon-c566132d45ab1a9bcae64d8d90e4378a.svg" width=24 height=24/> <a href="https://travis-ci.org/arcticicestudio/nord-hyper"><img src="https://img.shields.io/travis/arcticicestudio/nord-hyper/develop.svg?style=flat-square"/></a> <img src="https://circleci.com/favicon.ico" width=24 height=24/> <a href="https://circleci.com/gh/arcticicestudio/nord-hyper"><img src="https://img.shields.io/circleci/project/github/arcticicestudio/nord-hyper/develop.svg?style=flat-square"/></a> <img src="https://assets-cdn.github.com/favicon.ico" width=24 height=24/> <a href="https://github.com/arcticicestudio/nord-hyper/releases/latest"><img src="https://img.shields.io/github/release/arcticicestudio/nord-hyper.svg?style=flat-square"/></a> <a href="https://github.com/arcticicestudio/nord/releases/tag/v0.2.0"><img src="https://img.shields.io/badge/Nord-v0.2.0-88C0D0.svg?style=flat-square"/></a> <img src="https://www.npmjs.com/static/images/touch-icons/favicon-32x32.png" width=24 height=24/> <a href="https://www.npmjs.com/package/nord-hyper"><img src="https://img.shields.io/npm/v/nord-hyper.svg?style=flat-square"/></a> <a href="https://www.npmjs.com/package/nord-hyper"><img src="https://img.shields.io/npm/dt/nord-hyper.svg?style=flat-square"/></a> <a href="https://www.npmjs.com/package/nord-hyper"><img src="https://img.shields.io/npm/dm/nord-hyper.svg?style=flat-square"/></a></p>
 
-<p align="center">An arctic, north-bluish clean and elegant <a href="https://hyper.is">Hyper</a> theme plugin.</p>
-
-<p align="center">Designed for a fluent and clear workflow.<br>
-Based on the <a href="https://github.com/arcticicestudio/nord">Nord</a> color palette.</p>
+<p align="center"><a href="https://arcticicestudio.github.io/nord-hyper"><img src="https://img.shields.io/badge/docs-0.4.0-81A1C1.svg?style=flat-square"/></a> <a href="https://github.com/arcticicestudio/nord-hyper/blob/v0.4.0/CHANGELOG.md"><img src="https://img.shields.io/badge/Changelog-0.4.0-81A1C1.svg?style=flat-square"/></a></p>
 
 ---
 
+<p align="center">An arctic, north-bluish clean and elegant <a href="https://hyper.is">Hyper</a> theme plugin.</p>
+
+<p align="center">Designed for a fluent and clear workflow based on the <a href="https://github.com/arcticicestudio/nord">Nord</a> color palette.</p>
+
 <p align="center"><img src="https://raw.githubusercontent.com/arcticicestudio/nord-hyper/develop/assets/scrot-top.png"/><blockquote>Font: <a href="https://adobe-fonts.github.io/source-code-pro">Source Code Pro</a> 16px.</blockquote></p>
 
-## Getting started
-### Installation
-#### <a href="https://hyper.is/#extensions"><img src="https://hyper.is/favicon.png" width=24 height=24/> Manual</a>
-Add `nord-hyper` to your `~/.hyper.js` plugin list:
+## Features
+
+<p align="center"><strong>Smooth transitions for tab interactions.</strong><br><img src="https://raw.githubusercontent.com/arcticicestudio/nord-hyper/develop/assets/scrot-feature-tabs.png"/><br><img src="https://raw.githubusercontent.com/arcticicestudio/nord-hyper/develop/assets/scrcast-feature-smooth-tab-transition.gif"/></p>
+
+## Getting Started
+
+The [project documentation][docs] contains chapters to learn about the [installation][docs-getting-started-installation] and development [requirements][docs-getting-started-requirements], [learn how to build][docs-dev-building] the project and [run the tests][docs-dev-testing].
+
+### Quick Start
+
+Nord Hyper can be installed manually by adding `nord-hyper` to your `~/.hyper.js` plugin list:
+
 ```js
 plugins: [
   'nord-hyper'
 ]
 ```
+
 The configuration file can be opened with
-  - <img src="https://developer.apple.com/favicon.ico" width=16 height=16/> `⌘ + ,`
-  - <img src="https://www.kernel.org/theme/images/logos/favicon.png" width=16 height=16/> <img src="https://www.microsoft.com/favicon.ico" width=16 height=16/> `Ctrl + ,`
+
+* <img src="https://developer.apple.com/favicon.ico" width=16 height=16/> <kbd>⌘</kbd> + <kbd>,</kbd>
+* <img src="https://www.kernel.org/theme/images/logos/favicon.png" width=16 height=16/> <img src="https://www.microsoft.com/favicon.ico" width=16 height=16/> <kbd>Ctrl</kbd> + <kbd>,</kbd>
 
 and reloaded with
-  - <img src="https://developer.apple.com/favicon.ico" width=16 height=16/> `⌘ ⇧ R`
-  - <img src="https://www.kernel.org/theme/images/logos/favicon.png" width=16 height=16/> <img src="https://www.microsoft.com/favicon.ico" width=16 height=16/> `Ctrl ⇧ R`
 
-#### <a href="https://www.npmjs.com/package/hpm-cli"><img src="https://hyper.is/favicon.png" width=24 height=24/> hpm</a>
-Install `nord-hyper` from the command line:
+* <img src="https://developer.apple.com/favicon.ico" width=16 height=16/> <kbd>⌘</kbd> + <kbd>Shift</kbd> + <kbd>R</kbd>
+* <img src="https://www.kernel.org/theme/images/logos/favicon.png" width=16 height=16/> <img src="https://www.microsoft.com/favicon.ico" width=16 height=16/> <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>R</kbd>
+
+It can also be installed from the command line via [hpm][npm-hpm-cli] by running
+
 ```sh
 hpm install nord-hyper
 ```
 
-## Features
-<p align="center"><strong>Smooth transitions for tab interactions.</strong><br><img src="https://raw.githubusercontent.com/arcticicestudio/nord-hyper/develop/assets/scrot-feature-tabs.png"/><br><img src="https://raw.githubusercontent.com/arcticicestudio/nord-hyper/develop/assets/scrcast-feature-smooth-tab-transition.gif"/></p>
-
-## Development
-[![](https://img.shields.io/badge/Changelog-0.4.0-81A1C1.svg?style=flat-square)](https://github.com/arcticicestudio/nord-hyper/blob/v0.4.0/CHANGELOG.md) [![](https://img.shields.io/badge/Workflow-gitflow--branching--model-81A1C1.svg?style=flat-square)](http://nvie.com/posts/a-successful-git-branching-model) [![](https://img.shields.io/badge/Versioning-ArcVer_0.8.0-81A1C1.svg?style=flat-square)](https://github.com/arcticicestudio/arcver)
+## Contributing
 
-Continuous integration builds are running at [Travis-CI](https://travis-ci.org/arcticicestudio/nord-hyper) and [Circle CI](https://circleci.com/gh/arcticicestudio/nord-hyper).
+Read the [contributing guide][docs-dev-contributing] to learn about the development process and how to propose [enhancement suggestions][docs-dev-contributing-enhancements] and [report bugs][docs-dev-contributing-bug-reports], how to [submit pull requests][docs-dev-contributing-pr] and the project's [styleguides][docs-dev-contributing-styleguides], [branch organization][docs-dev-contributing-branch-org] and [versioning][docs-dev-contributing-versioning] model.
 
-### Contribution
-Please report issues/bugs, feature requests and suggestions for improvements to the [issue tracker](https://github.com/arcticicestudio/nord-hyper/issues).
+The guide also includes information about [minimal, complete, and verifiable examples][docs-dev-contributing-mcve] and other ways to contribute to the project like [improving existing issues][docs-dev-contributing-other-improve-issues] and [giving feedback on issues and pull requests][docs-dev-contributing-other-feedback].
 
-<p align="center"><img src="https://cdn.rawgit.com/arcticicestudio/nord/develop/src/assets/banner-footer-mountains.svg" /></p>
+---
 
 <p align="center">Copyright &copy; 2017-present Arctic Ice Studio</p>
 
 <p align="center"><a href="https://github.com/arcticicestudio/nord-hyper/blob/develop/LICENSE.md"><img src="https://img.shields.io/badge/License-MIT-5E81AC.svg?style=flat-square"/></a> <a href="https://creativecommons.org/licenses/by-sa/4.0"><img src="https://img.shields.io/badge/License-CC_BY--SA_4.0-5E81AC.svg?style=flat-square"/></a></p>
+
+[docs]: https://arcticicestudio.github.io/nord-hyper
+[docs-dev-building]: https://arcticicestudio.github.io/nord-hyper/development/building.html
+[docs-dev-contributing]: https://arcticicestudio.github.io/nord-hyper/development/contributing.html
+[docs-dev-contributing-branch-org]: https://arcticicestudio.github.io/nord-hyper/development/contributing.html#branch-organization
+[docs-dev-contributing-bug-reports]: https://arcticicestudio.github.io/nord-hyper/development/contributing.html#bug-reports
+[docs-dev-contributing-enhancements]: https://arcticicestudio.github.io/nord-hyper/development/contributing.html#enhancement-suggestions
+[docs-dev-contributing-mcve]: https://arcticicestudio.github.io/nord-hyper/development/contributing.html#mcve
+[docs-dev-contributing-other-feedback]: https://arcticicestudio.github.io/nord-hyper/development/contributing.html#give-feedback-on-issues-and-pull-requests
+[docs-dev-contributing-other-improve-issues]: https://arcticicestudio.github.io/nord-hyper/development/contributing.html#improve-issues
+[docs-dev-contributing-pr]: https://arcticicestudio.github.io/nord-hyper/development/contributing.html#pull-requests
+[docs-dev-contributing-styleguides]: https://arcticicestudio.github.io/nord-hyper/development/contributing.html#styleguides
+[docs-dev-contributing-versioning]: https://arcticicestudio.github.io/nord-hyper/development/contributing.html#versioning
+[docs-dev-testing]: https://arcticicestudio.github.io/nord-hyper/development/testing.html
+[docs-getting-started-installation]: https://arcticicestudio.github.io/nord-hyper/getting-started/installation.html
+[docs-getting-started-requirements]: https://arcticicestudio.github.io/nord-hyper/getting-started/requirements.html
+[npm-hpm-cli]: https://www.npmjs.com/package/hpm-cli