-
-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
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
- Loading branch information
1 parent
775161e
commit 42382cd
Showing
15 changed files
with
257 additions
and
26 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| * text eol=lf |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -10,3 +10,8 @@ pids | |
| *.pid | ||
| *.seed | ||
| *.pid.lock | ||
|
|
||
| # +-------------------+ | ||
| # + Project Strcuture + | ||
| # +-------------------+ | ||
| build/ | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| <p align="center"><img src="https://cdn.rawgit.com/arcticicestudio/nord-hyper/develop/assets/nord-hyper-banner.svg"/></p> | ||
|
|
||
| <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 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> | ||
|
|
||
| ## 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> | ||
|
|
||
| --- | ||
|
|
||
| <p align="center">Copyright © 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> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| # Summary | ||
|
|
||
| ### Introduction | ||
| - [Overview](README.md) | ||
| - [Features](README.md#features) | ||
|
|
||
| ### Getting Started | ||
| - [Requirements](getting-started/requirements.md) | ||
| - [Installation](getting-started/installation.md) | ||
|
|
||
| ### Development | ||
| - [Building](development/building.md) | ||
| - [Documentations](development/building.md#documentations) | ||
| - [Testing](development/testing.md) | ||
| - [Linting](development/testing.md#linting) | ||
| - [Contributing](development/contributing.md) | ||
| - [Getting Started](development/contributing.md#getting-started) | ||
| - [Bug Reports](development/contributing.md#bug-reports) | ||
| - [Enhancement Suggestions](development/contributing.md#enhancement-suggestions) | ||
| - [Pull Requests](development/contributing.md#pull-requests) | ||
| - [Documentations](development/contributing.md#documentations) | ||
| - [Branch Organization](development/contributing.md#branch-organization) | ||
| - [How else can I help?](development/contributing.md#how-else-can-i-help) | ||
| - [Improve Issues](development/contributing.md#improve-issues) | ||
| - [Give Feedback On Issues and Pull Requests](development/contributing.md#give-feedback-on-issues-and-pull-requests) | ||
| - [Styleguides](development/contributing.md#styleguides) | ||
| - [JavaScript Code Style](development/contributing.md#javascript-code-style) | ||
| - [Git Commit Messages](development/contributing.md#git-commit-messages) | ||
| - [MCVE](development/contributing.md#mcve) | ||
| - [Versioning](development/contributing.md#versioning) | ||
| - [Credits](development/contributing.md#credits) | ||
| - [Changelog](development/changelog.md) | ||
| - [0.4.0](development/changelog.md#040) | ||
| - [0.3.0](development/changelog.md#030) | ||
| - [0.2.0](development/changelog.md#020) | ||
| - [0.1.0](development/changelog.md#010) | ||
| - [Code of Conduct](development/code-of-conduct.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| { | ||
| "gitbook": "3.2.3", | ||
| "title": "Nord Hyper", | ||
| "description": "An arctic, north-bluish clean and elegant Hyper theme plugin.", | ||
| "author": "Arctic Ice Studio", | ||
| "plugins": ["anchorjs", "github", "toggle-chapters", "toggle-headers", "-sharing"], | ||
| "pluginsConfig": { | ||
| "github": { | ||
| "url": "https://github.com/arcticicestudio/nord-hyper" | ||
| }, | ||
| "lunr": { | ||
| "maxIndexSize": 200000 | ||
| }, | ||
| "theme-default": { | ||
| "styles": { | ||
| "website": "./styles/website.css" | ||
| } | ||
| } | ||
| }, | ||
| "variables": { | ||
| "technologies": { | ||
| "nodejs": { | ||
| "version": "8" | ||
| } | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| > Please make sure to complete the [requirement][requirements] steps first in order to build the project! | ||
| Run `npm install` from within the project root to bootstrap the project and install all dependencies. | ||
|
|
||
| Continuous integration builds are running at [Travis CI][travis-ci] and [Circle CI][circle-ci]. | ||
|
|
||
| ## Documentations | ||
|
|
||
| This documentation can be build by runnning | ||
|
|
||
| ```sh | ||
| npm run docs:build | ||
| ``` | ||
|
|
||
| from within the project root to bootstrap the build toolchain and install all dependencies. | ||
|
|
||
| The output will be placed in the `build/docs` directory. | ||
|
|
||
| To start the local hot reload server with browser live reload, using the default port `4000`, run | ||
|
|
||
| ```sh | ||
| npm run docs:dev | ||
| ``` | ||
|
|
||
| [requirements]: ../getting-started/requirements.md | ||
|
|
||
| [circle-ci]: https://circleci.com/gh/arcticicestudio/nord-hyper | ||
| [nodejs]: https://nodejs.org/en/download/current | ||
| [travis-ci]: https://travis-ci.org/arcticicestudio/nord-hyper |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| {% include "git+https://github.com/arcticicestudio/nord-hyper.git/CHANGELOG.md" %} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| {% include "git+https://github.com/arcticicestudio/nord-hyper.git/CODE_OF_CONDUCT.md" %} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| {% include "git+https://github.com/arcticicestudio/nord-hyper.git/CONTRIBUTING.md" %} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| > Please make sure to complete the [requirement][requirements] and [installation][installation] steps first in order to build the project! | ||
| ## Linting | ||
|
|
||
| Nord Hyper uses [ESLint][eslint] to analyse the source code. To show the current lint status run | ||
|
|
||
| ```sh | ||
| gulp lint | ||
| ``` | ||
|
|
||
| [installation]: ../getting-started/installation.md | ||
| [requirements]: ../getting-started/requirements.md | ||
|
|
||
| [eslint]: https://eslint.org |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| ## Manual | ||
|
|
||
| Add `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/> <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/> <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> | ||
|
|
||
| ## hpm | ||
|
|
||
| Nord Hyper can be installed from the command line via [hpm][npm-hpm-cli] by running | ||
|
|
||
| ```sh | ||
| hpm install nord-hyper | ||
| ``` | ||
|
|
||
| [npm-hpm-cli]: https://www.npmjs.com/package/hpm-cli |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| ## Node.js | ||
|
|
||
| Nord Hyper is build with [Node.js](https://nodejs.org). Currently tested and supported versions are [{{book.technologies.node.version}}][nodejs] or higher. It comes prebundled with the package manager which can be used from the CLI. | ||
|
|
||
| ### npm | ||
|
|
||
| NodeJ.js comes prebundled with the package manager [npm][npm] which can be used from the CLI. | ||
|
|
||
| [nodejs]: https://nodejs.org/en/download/releases | ||
| [npm]: https://npmjs.com |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| /* Remove the sidebar link to the hosted gitbook service */ | ||
| .gitbook-link { | ||
| display: none !important; | ||
| } | ||
|
|
||
| /* Sidebar links */ | ||
| .book .book-summary nav ul.summary li a { | ||
| color: #444444; | ||
| text-decoration: none; | ||
| } | ||
|
|
||
| .book .book-summary nav ul.summary li a:hover, | ||
| .book .book-summary nav ul.summary li a:focus { | ||
| color: #000000; | ||
| } | ||
|
|
||
| .book .book-summary nav ul.summary li.active > a { | ||
| color: #008cff; | ||
| } | ||
|
|
||
| /* anchor.js hover icons */ | ||
| .book .book-body .page-wrapper .page-inner section.normal a.anchorjs-link { | ||
| color: #008cff; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters