Merge branch 'develop'

Author: ff6347

.eslintrc.js

@@ -1,27 +1,23 @@
 module.exports = {
-    extends: [
-      'unobtrusive',
-      'eslint:recommended'
-        ],
-    plugins: ['babel'],
-    env: {
-      browser: true,
-      node: true,
-    },
-    globals: {
-    },
-    rules: {
-      semi: [2, 'always'],
-      quotes: [2, 'single'],
-      indent: [2, 2],
-      'linebreak-style': [2, 'unix'],
-      'brace-style': [2, '1tbs'],
-      'array-bracket-spacing': [2, 'never'],
-      camelcase: [2, {properties: 'always'}],
-      'keyword-spacing': [2],
-      'eol-last': [2],
-      'no-trailing-spaces': [2],
-      'no-process-env': ['off', 'always'],
-      'no-console': ['off','always']
-    }
-  };
+  extends: ["unobtrusive", "eslint:recommended"],
+  plugins: ["babel"],
+  env: {
+    browser: true,
+    node: true
+  },
+  globals: {},
+  rules: {
+    semi: [2, "always"],
+    quotes: [2, "double"],
+    indent: [2, 2],
+    "linebreak-style": [2, "unix"],
+    "brace-style": [2, "1tbs"],
+    "array-bracket-spacing": [2, "never"],
+    camelcase: [2, { properties: "always" }],
+    "keyword-spacing": [2],
+    "eol-last": [2],
+    "no-trailing-spaces": [2],
+    "no-process-env": ["off", "always"],
+    "no-console": ["off", "always"]
+  }
+};

.github/workflows/test.yml

@@ -0,0 +1,36 @@
+# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: Tests
+
+on:
+  push:
+  pull_request:
+    branches: [ master, develop ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [10.x, 12.x]
+
+    steps:
+    - uses: actions/setup-ruby@v1
+      with:
+        ruby-version: '2.6'
+    - uses: actions/checkout@v2
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v1
+      with:
+        node-version: ${{ matrix.node-version }}
+        
+    - run: gem install bundler 
+    - run: bundle install
+    - run: npm ci
+    - run: npm run build --if-present
+    - run: npm test
+      env:
+        CI: true

.gitignore

@@ -2,6 +2,7 @@
 package-lock.json
 node_modules
 test/report.txt
+.vscode
 
 # File created using '.gitignore Generator' for Visual Studio Code: https://bit.ly/vscode-gig
 # Created by https://www.gitignore.io/api/jekyll,node

.node-version

@@ -0,0 +1 @@
+ruby 2.6.2

.ruby-version

@@ -9,7 +9,7 @@ ruby RUBY_VERSION
 #
 # This will help ensure the proper Jekyll version is running.
 # Happy Jekylling!
-gem "jekyll", "3.8.5"
+gem "jekyll", "~> 4.0.0"
 
 
 # If you want to use GitHub Pages, remove the "gem "jekyll"" above and

Gemfile

@@ -1,70 +1,72 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.5.2)
-      public_suffix (>= 2.0.2, < 4.0)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
     colorator (1.1.0)
-    concurrent-ruby (1.1.3)
+    concurrent-ruby (1.1.6)
     em-websocket (0.5.1)
       eventmachine (>= 0.12.9)
       http_parser.rb (~> 0.6.0)
     eventmachine (1.2.7)
-    ffi (1.9.25)
+    ffi (1.12.2)
     forwardable-extended (2.6.0)
     http_parser.rb (0.6.0)
-    i18n (0.9.5)
+    i18n (1.8.2)
       concurrent-ruby (~> 1.0)
-    jekyll (3.8.5)
+    jekyll (4.0.0)
       addressable (~> 2.4)
       colorator (~> 1.0)
       em-websocket (~> 0.5)
-      i18n (~> 0.7)
-      jekyll-sass-converter (~> 1.0)
+      i18n (>= 0.9.5, < 2)
+      jekyll-sass-converter (~> 2.0)
       jekyll-watch (~> 2.0)
-      kramdown (~> 1.14)
+      kramdown (~> 2.1)
+      kramdown-parser-gfm (~> 1.0)
       liquid (~> 4.0)
       mercenary (~> 0.3.3)
       pathutil (~> 0.9)
-      rouge (>= 1.7, < 4)
+      rouge (~> 3.0)
       safe_yaml (~> 1.0)
-    jekyll-feed (0.11.0)
-      jekyll (~> 3.3)
-    jekyll-sass-converter (1.5.2)
-      sass (~> 3.4)
-    jekyll-watch (2.1.2)
+      terminal-table (~> 1.8)
+    jekyll-feed (0.13.0)
+      jekyll (>= 3.7, < 5.0)
+    jekyll-sass-converter (2.1.0)
+      sassc (> 2.0.1, < 3.0)
+    jekyll-watch (2.2.1)
       listen (~> 3.0)
-    kramdown (1.17.0)
-    liquid (4.0.1)
-    listen (3.1.5)
-      rb-fsevent (~> 0.9, >= 0.9.4)
-      rb-inotify (~> 0.9, >= 0.9.7)
-      ruby_dep (~> 1.2)
+    kramdown (2.1.0)
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    liquid (4.0.3)
+    listen (3.2.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
     mercenary (0.3.6)
     pathutil (0.16.2)
       forwardable-extended (~> 2.6)
-    public_suffix (3.0.3)
+    public_suffix (4.0.3)
     rb-fsevent (0.10.3)
-    rb-inotify (0.9.10)
-      ffi (>= 0.5.0, < 2)
-    rouge (3.3.0)
-    ruby_dep (1.5.0)
-    safe_yaml (1.0.4)
-    sass (3.7.2)
-      sass-listen (~> 4.0.0)
-    sass-listen (4.0.0)
-      rb-fsevent (~> 0.9, >= 0.9.4)
-      rb-inotify (~> 0.9, >= 0.9.7)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rouge (3.17.0)
+    safe_yaml (1.0.5)
+    sassc (2.2.1)
+      ffi (~> 1.9)
+    terminal-table (1.8.0)
+      unicode-display_width (~> 1.1, >= 1.1.1)
+    unicode-display_width (1.7.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  jekyll (= 3.8.5)
+  jekyll (~> 4.0.0)
   jekyll-feed (~> 0.6)
   tzinfo-data
 
 RUBY VERSION
-   ruby 2.6.0p0
+   ruby 2.6.2p47
 
 BUNDLED WITH
-   1.17.3
+   2.1.4

Gemfile.lock

@@ -7,6 +7,13 @@ Hosted on:
 [![Netlify Badge](https://www.netlify.com/img/global/badges/netlify-color-accent.svg)](https://basiljs2.netlify.com/)
 
 This repo holds the [site/docs for Basil.js](https://basiljs.github.io/). The current state of development (develop branch) can be found here [basiljs2.netlify.com](https://basiljs2.netlify.com/)
+
+## Prerequisits
+
+- Ruby >= 2.6
+  - Ruby Bundler
+- Node.js >= 10
+
 ## Update Basil API  
 
 If there are changes to the API of Basil.js you can update the data on this repo as follows.  
@@ -18,6 +25,8 @@ cd basiljs.github.io
 # get all branches
 git fetch -a
 # get into the develop branch
+# this is currently the one that serves the page
+# your pull request should also be against develop not master (at the moment)
 git checkout -b develop origin/develop
 # now make your new branch based on develop
 git checkout -b chore/update-docs
@@ -40,6 +49,7 @@ git commit -m "chore: Update Basil.js api to latest state [Add your favorite emo
 # push current HEAD to remote
 git push -u origin HEAD
 # Now go to the GitHub UI and create your PR
+# Against the develop branch (not master).
 ```
 
 This repo holds the [site/docs for Basil.js](https://basiljs.github.io/). The current state of development (develop branch) can be found here [basiljs2.netlify.com](https://basiljs2.netlify.com/)
@@ -54,37 +64,71 @@ To build these docs we are using [Webpack](https://webpack.js.org/) and [Jekyll]
 
 Netlify will create a branch and deploy preview for you and you can see your changes online. Every push to your branch will trigger a new build and will be linked on the PR page.
 
+
+
 To develop locally take a look at the steps below. 👇
 
-### Markup + SCSS
+### Setup
+
+```bash
+# Ruby/Jekyll setup
+gem install bundler
+bundle install
+
+
+# Node Webpack setup
+npm install
+# or
+npm ci
+```
+
+### Markup & SCSS & JS
+
+To run the full development process you need to run Webpack and Jekyll side by side. They are combined in a script call `dev`.
+
+```bash
+npm run dev
+```
+
+Your site will be served from [http://0.0.0.0:4000](http://0.0.0.0:4000)
+
+### Markup
 
 Most of the Jekyll [liquid magic](https://github.com/Shopify/liquid/wiki/Liquid-for-Designers) happens in `./_source`.  
 
 To develop in this run:
 
 ```bash
-# once
-bundle install
-bundle update
 # whenever you want to work on the markup/content
 # (the --limit_posts 1 --incremental flags are needed
 # because we have lots of pages and need to speedup the build)
 bundle exec jekyll serve --livereload --limit_posts 1 --incremental
+# in a second shell session run
 ```
 
-### Javascript
+### Javascript + SCSS
 
-To work on the Javasscript of the site you need to run
+To work on the Javascript and SCSS of the site you need to run
 
 ```bash
-# once
-# needs npm v5.7 or higer
-npm ci
 # when you develop on it
 # (starts the webpack dev watch build toolchain)
 npm run webpack:dev
 ```
 
+## Gallery Content
+
+To add a new gallery item you can duplicate the folder `_source/gallery/example-gallery-item`
+
+There Need to be two images present.
+
+1. thumbnail.png with a size of 320 × 180 px (this will be used in the gallery overview)
+2. splash.png with a size of 1280 × 720 px (this will be used on the start page if featured is true)
+
+You also should replace all the values in the frontmatter of the `index.md` file.  
+
+Please set your project first to `publish: false` and also the `featured: false` to get a review by the maintainers.
+
 ## Recipes
 
 Resize and crop multiple images using [`mogrify`](https://www.imagemagick.org/script/mogrify.php)  
@@ -96,7 +140,7 @@ mogrify -resize 320x180^ -gravity Center -extent 320x180 -quality 100 -format pn
 
 ## License
 
-Copyright (c)  2013-2019 Basil.js
+Copyright (c)  2013-2020 Basil.js
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software  without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to  permit persons to whom the Software is furnished to do so, subject to the following conditions:  
 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A  PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF  CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.  

README.md

@@ -25,9 +25,10 @@ url: "https://basiljs.github.io/" # the base hostname & protocol for your site,
 twitter_username: basil_js
 github_username:  basiljs
 
-sass:
-    style: compressed
-    sass_dir: _sass
+host: 0.0.0.0
+# sass:
+#     style: compressed
+#     sass_dir: _sass
 # Build settings
 markdown: kramdown
 # kramdown:
@@ -36,6 +37,7 @@ highlighter: rouge
 plugins:
   - jekyll-feed
 exclude:
+  - assets/ts
   - Gemfile
   - Gemfile.lock
   - package.json