Use GitHub Pages for documentation

.travis.yml

@@ -3,16 +3,28 @@ branches:
   only:
     master
 
-before_install:
-  - sudo apt-get -qq update
-  - sudo apt-get install -y python-jsonschema python-pil gettext
+matrix:
+  include:
+    - stage: Update translations
+      before_install:
+        - sudo apt-get -qq update
+        - sudo apt-get install -y python-jsonschema python-pil gettext
+      script:
+        - python ./validate.py
+      after_success:
+        # push translation updates only for master (PR changes must be committed to master before they are taken into account)
+        - if [ "$TRAVIS_BRANCH" == "master" ] && [ "$TRAVIS_PULL_REQUEST" == "false" ]; then ./i18n/push_translations.sh; fi
 
-script:
-  - python ./validate.py
-
-after_success:
-  # push translation updates only for master (PR changes must be committed to master before they are taken into account)
-  - if [ "$TRAVIS_BRANCH" == "master" ] && [ "$TRAVIS_PULL_REQUEST" == "false" ]; then ./i18n/push_translations.sh; fi
+    # Check GitHub Pages
+    - stage: Check GitHub Pages
+      os: linux
+      language: ruby
+      rvm:
+        - 2.1
+      before_install: cd docs
+      script:
+        - bundle exec jekyll build
+        - bundle exec htmlproofer ./_site --only-4xx --check-favicon --check-html --assume-extension --file-ignore=/jsdoc/
 
 env:
   global:

README.md

@@ -31,8 +31,8 @@
     Even if the application name contains ®, ™ or the like, you should not use it in the folder name.
 
 3. Fill the files:
-  * [script.js](https://github.com/PlayOnLinux/Scripts/wiki/script.js): actual installation script
-  * [script.json](https://github.com/PlayOnLinux/Scripts/wiki/script.json): describes the installation script
+  * [script.js](https://phoenicisorg.github.io/scripts/script-js): actual installation script
+  * [script.json](https://phoenicisorg.github.io/scripts/script-json): describes the installation script
   ```json
   {
 		"scriptName": "Online",
@@ -43,7 +43,7 @@
   }
   ```
   * main.png: application icon (400px x 300px)
-  * [application.json](https://github.com/PlayOnLinux/Scripts/wiki/application.json): describes the application
+  * [application.json](https://phoenicisorg.github.io/scripts/application-json): describes the application
   ```json
   {
  		"name":	"Steam",

docs/Gemfile

@@ -0,0 +1,11 @@
+source "https://rubygems.org"
+
+gem "jekyll"
+gem "jekyll-remote-theme"
+
+gem "github-pages", group: :jekyll_plugins
+
+# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
+gem "tzinfo-data", platforms: [:mingw, :mswin, :x64_mingw, :jruby]
+
+gem "html-proofer"

docs/_config.yml

@@ -0,0 +1,51 @@
+title                    : Phoenicis Scripts Documentation
+name                     : phoenicis.org
+description              : The documentation for Phoenicis scripts.
+repository               : PhoenicisOrg/scripts
+
+remote_theme             : mmistakes/minimal-mistakes
+minimal_mistakes_skin    : air
+
+markdown                 : kramdown
+permalink                : /:categories/:title/
+
+plugins:
+  - jekyll-paginate
+  - jekyll-sitemap
+  - jekyll-gist
+  - jekyll-feed
+  - jemoji
+  - jekyll-remote-theme
+
+# mimic GitHub Pages with --safe
+whitelist:
+  - jekyll-paginate
+  - jekyll-sitemap
+  - jekyll-gist
+  - jekyll-feed
+  - jemoji
+
+include:
+  - _pages
+
+encoding: "utf-8"
+markdown_ext: "markdown,mkdown,mkdn,mkd,md"
+
+defaults:
+  # _pages
+  - scope:
+      path: "_pages"
+      type: pages
+    values:
+      layout: single
+      author_profile: false
+      sidebar:
+        nav: "docs"
+
+author:
+  name:   Phoenicis
+  github: PhoenicisOrg
+
+# HTML Compression
+compress_html:
+  clippings: all

docs/_data/navigation.yml

@@ -0,0 +1,23 @@
+docs:
+  - title: "Develop"
+    children:
+      - title: "application.json"
+        url: /application-json/
+      - title: "script.json"
+        url: /script-json/  
+      - title: "script.js"
+        url: /script-js/
+      - title: "Utils"
+        url: /utils/
+      - title: "Verbs"
+        url: /verbs/
+      - title: "SetupWizard"
+        url: /setup-wizard/
+      - title: "JSDoc"
+        url: /jsdoc/
+  - title: "General"
+    children:
+      - title: "Translation"
+        url: /translation/
+      - title: "Best practices"
+        url: /best-practices/

docs/_includes/head/custom.html

@@ -0,0 +1,9 @@
+<link rel="apple-touch-icon" sizes="180x180" href="/assets/images/apple-touch-icon.png">
+<link rel="icon" type="image/png" sizes="32x32" href="/assets/images/favicon-32x32.png">
+<link rel="icon" type="image/png" sizes="16x16" href="/assets/images/favicon-16x16.png">
+<link rel="manifest" href="/assets/images/site.webmanifest">
+<link rel="mask-icon" href="/assets/images/safari-pinned-tab.svg" color="#5bbad5">
+<link rel="shortcut icon" href="/assets/images/favicon.ico">
+<meta name="msapplication-TileColor" content="#da532c">
+<meta name="msapplication-config" content="/assets/images/browserconfig.xml">
+<meta name="theme-color" content="#ffffff">

docs/_pages/application-json.md

@@ -0,0 +1,19 @@
+---
+title: "application.json"
+permalink: /application-json/
+toc: false
+---
+
+This file describes the application.
+
+```json
+{
+	"name":	"Application",
+	"id":	"application",
+	"description": "Application description"
+}
+```
+
+If the application name contains ®, ™ or the like, you should use it here.
+
+The `description` supports HTML (see [Photofiltre](https://github.com/PhoenicisOrg/scripts/blob/master/Applications/Graphics/Photofiltre/application.json)).

docs/_pages/best-practices.md

@@ -0,0 +1,17 @@
+---
+title: "Best practices"
+permalink: /best-practices/
+toc: false
+---
+
+This page describes best practices for writing your scripts.
+
+1. Fork the repository
+2. Create a new branch for your script
+3. Clone your fork to your local scripts repository (usually `~/.Phoenicis/repository/`)
+4. Checkout your branch
+5. Follow the [how to](https://github.com/PhoenicisOrg/scripts/blob/master/README.md)
+6. Commit your changes and create a pull request
+
+## Unfinished scripts
+If your script is unfinished/not fully tested but you still want to share it (e.g. because you need help), create a pull request and label it "help wanted". People can then help you with comments or by submitting pull requests for the branch on your fork.

docs/_pages/home.md

@@ -0,0 +1,6 @@
+---
+permalink: /
+---
+
+This is the documentation for the scripts for [Phoenicis](https://github.com/PhoenicisOrg/phoenicis). 
+