From 42382cd33f2f8e39625fe465bfad2713a008b82c Mon Sep 17 00:00:00 2001 From: Arctic Ice Studio Date: Sun, 7 Jan 2018 11:04:38 +0100 Subject: [PATCH] Add 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 --- .gitattributes | 1 + .gitignore | 5 ++ README.md | 70 +++++++++++++++++++--------- docs/README.md | 21 +++++++++ docs/SUMMARY.md | 37 +++++++++++++++ docs/book.json | 27 +++++++++++ docs/development/building.md | 29 ++++++++++++ docs/development/changelog.md | 1 + docs/development/code-of-conduct.md | 1 + docs/development/contributing.md | 1 + docs/development/testing.md | 14 ++++++ docs/getting-started/installation.md | 29 ++++++++++++ docs/getting-started/requirements.md | 10 ++++ docs/styles/website.css | 24 ++++++++++ package.json | 13 ++++-- 15 files changed, 257 insertions(+), 26 deletions(-) create mode 100644 .gitattributes create mode 100644 docs/README.md create mode 100644 docs/SUMMARY.md create mode 100644 docs/book.json create mode 100644 docs/development/building.md create mode 100644 docs/development/changelog.md create mode 100644 docs/development/code-of-conduct.md create mode 100644 docs/development/contributing.md create mode 100644 docs/development/testing.md create mode 100644 docs/getting-started/installation.md create mode 100644 docs/getting-started/requirements.md create mode 100644 docs/styles/website.css diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..fcadb2c --- /dev/null +++ b/.gitattributes @@ -0,0 +1 @@ +* text eol=lf diff --git a/.gitignore b/.gitignore index 1f8df81..d7937f3 100644 --- a/.gitignore +++ b/.gitignore @@ -10,3 +10,8 @@ pids *.pid *.seed *.pid.lock + +# +-------------------+ +# + Project Strcuture + +# +-------------------+ +build/ diff --git a/README.md b/README.md index 894e85b..109bc2f 100644 --- a/README.md +++ b/README.md @@ -2,51 +2,75 @@

-

An arctic, north-bluish clean and elegant Hyper theme plugin.

- -

Designed for a fluent and clear workflow.
-Based on the Nord color palette.

+

--- +

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.

-## Getting started -### Installation -#### Manual -Add `nord-hyper` to your `~/.hyper.js` plugin list: +## Features + +

Smooth transitions for tab interactions.

+ +## 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 - - `⌘ + ,` - - `Ctrl + ,` + +* ⌘ + , +* Ctrl + , and reloaded with - - `⌘ ⇧ R` - - `Ctrl ⇧ R` -#### hpm -Install `nord-hyper` from the command line: +* ⌘ + Shift + R +* Ctrl + Shift + R + +It can also be installed from the command line via [hpm][npm-hpm-cli] by running + ```sh hpm install nord-hyper ``` -## Features -

Smooth transitions for tab interactions.

- -## 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]. -

+---

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 + +* ⌘ + , +* Ctrl + , + +and reloaded with + +* ⌘ + Shift + R +* Ctrl + Shift + R + +## 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 diff --git a/docs/getting-started/requirements.md b/docs/getting-started/requirements.md new file mode 100644 index 0000000..f3aa24d --- /dev/null +++ b/docs/getting-started/requirements.md @@ -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 diff --git a/docs/styles/website.css b/docs/styles/website.css new file mode 100644 index 0000000..74e6b4b --- /dev/null +++ b/docs/styles/website.css @@ -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; +} diff --git a/package.json b/package.json index f5ba8ee..71c15c2 100644 --- a/package.json +++ b/package.json @@ -28,10 +28,17 @@ "hyperterm", "hyper-theme" ], + "scripts": { + "docs:build": "npm run docs:clean && gitbook install ./docs && gitbook build ./docs ./build/docs", + "docs:clean": "node_modules/.bin/del ./build/docs", + "docs:dev": "npm run docs:build && gitbook serve ./docs ./build/docs" + }, "devDependencies": { - "eslint": "3.15.0", + "del-cli": "1.1.0", + "eslint": "4.15.0", + "gitbook-cli": "2.3.2", "gulp": "3.9.1", - "gulp-help": "1.6.1", - "gulp-eslint": "3.0.1" + "gulp-eslint": "4.0.1", + "gulp-help": "1.6.1" } }