From 42382cd33f2f8e39625fe465bfad2713a008b82c Mon Sep 17 00:00:00 2001
From: Arctic Ice Studio An arctic, north-bluish clean and elegant Hyper theme plugin. Designed for a fluent and clear workflow. An arctic, north-bluish clean and elegant Hyper theme plugin. Designed for a fluent and clear workflow based on the Nord color palette.
-Based on the Nord color palette.Font: Source Code Pro 16px.
Smooth transitions for tab interactions.
Smooth transitions for tab interactions.
Copyright © 2017-present Arctic Ice Studio
+ +[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 diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..14ccd55 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,21 @@ +An arctic, north-bluish clean and elegant Hyper theme plugin.
+ +Designed for a fluent and clear workflow based on the Nord color palette.
+ +Font: Source Code Pro 16px.+ +## Features + +
Smooth transitions for tab interactions.
Copyright © 2017-present Arctic Ice Studio
+ + diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md new file mode 100644 index 0000000..e54c95a --- /dev/null +++ b/docs/SUMMARY.md @@ -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) diff --git a/docs/book.json b/docs/book.json new file mode 100644 index 0000000..cc2ac68 --- /dev/null +++ b/docs/book.json @@ -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" + } + } + } +} diff --git a/docs/development/building.md b/docs/development/building.md new file mode 100644 index 0000000..924f03d --- /dev/null +++ b/docs/development/building.md @@ -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 diff --git a/docs/development/changelog.md b/docs/development/changelog.md new file mode 100644 index 0000000..3e35e3d --- /dev/null +++ b/docs/development/changelog.md @@ -0,0 +1 @@ +{% include "git+https://github.com/arcticicestudio/nord-hyper.git/CHANGELOG.md" %} diff --git a/docs/development/code-of-conduct.md b/docs/development/code-of-conduct.md new file mode 100644 index 0000000..c7a3e26 --- /dev/null +++ b/docs/development/code-of-conduct.md @@ -0,0 +1 @@ +{% include "git+https://github.com/arcticicestudio/nord-hyper.git/CODE_OF_CONDUCT.md" %} diff --git a/docs/development/contributing.md b/docs/development/contributing.md new file mode 100644 index 0000000..62964c1 --- /dev/null +++ b/docs/development/contributing.md @@ -0,0 +1 @@ +{% include "git+https://github.com/arcticicestudio/nord-hyper.git/CONTRIBUTING.md" %} diff --git a/docs/development/testing.md b/docs/development/testing.md new file mode 100644 index 0000000..d1dfebf --- /dev/null +++ b/docs/development/testing.md @@ -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 diff --git a/docs/getting-started/installation.md b/docs/getting-started/installation.md new file mode 100644 index 0000000..d51072b --- /dev/null +++ b/docs/getting-started/installation.md @@ -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 + +*