Merge pull request #2 from processing/master

update my fork to the original repo

Author: montoyamoraga

.gitignore

@@ -24,6 +24,8 @@ node_modules
 .idea/
 
 src/templates/pages/examples/*
+src/templates/pages/learn/index.hbs
+src/templates/pages/libraries/index.hbs
 src/offline-reference
 !src/templates/pages/examples/.gitkeep
 dist/*

.lintstagedrc.js

@@ -0,0 +1,3 @@
+module.exports = {
+  'src/data/en.yml': () => ['grunt i18n --changed', 'git add i18n-tracking.yml']
+}

Gruntfile.js

@@ -23,18 +23,19 @@ module.exports = function(grunt) {
       dist: 'dist'
     },
     exec: {
-      build_examples: 'node <%= config.src %>/data/examples/build_examples/build.js <%= config.src %>/templates/pages/examples/'
+      build_examples: 'node <%= config.src %>/data/examples/build_examples/build.js <%= config.src %>/templates/pages/examples/',
+      build_libraries: 'node <%= config.src %>/data/libraries/build.js <%= config.src %>/templates/pages/libraries/',
+      build_learn: 'node <%= config.src %>/data/learn/build.js <%= config.src %>/templates/pages/learn/'
     },
     watch: {
       assemble: {
-        files: '<%= config.src %>/{content,data,templates}/{,*/}*.{md,hbs,yml,json}',
+        files: '<%= config.src %>/{content,data,templates}/**/*.{md,hbs,yml,json}',
         tasks: ['assemble']
       },
       css: {
         files: '<%= config.src %>/assets/css/*.css',
         tasks: [
           'concat:dist',
-          // 'uncss',
           'postcss'
         ]
       },
@@ -52,7 +53,8 @@ module.exports = function(grunt) {
           '<%= config.dist %>/assets/js/*.js',
           '<%= config.dist %>/assets/img/*.{png,jpg,jpeg,gif,webp,svg,ico}',
           '<%= config.dist %>/assets/p5_featured/{,*/}*.*',
-          '<%= config.dist %>/assets/learn/{,*/}*.*'
+          '<%= config.dist %>/assets/learn/{,*/}*.*',
+          '<%= config.dist %>/assets/contributor-docs/*.*'
         ]
       }
     },
@@ -81,10 +83,13 @@ module.exports = function(grunt) {
         options: {
           expand: true,
           flatten: true,
-          helpers: ['<%= config.src %>/assets/js/translation.js'],
           assets: '<%= config.dist %>/assets',
+          helpers: ['<%= config.src %>/assets/js/translation.js', '<%= config.src %>/assets/js/cache-busting.js'],
           layout: '<%= config.src %>/templates/layouts/default.hbs',
-          data: ['<%= config.src %>/data/**/*.{json,yml}', '!<%= config.src %>/data/reference/*.json'],
+          data: [
+            '<%= config.src %>/data/**/*.{json,yml}',
+            '!<%= config.src %>/data/reference/*.json'
+          ],
           partials: '<%= config.src %>/templates/partials/*.hbs',
           plugins: [
             'assemble-contrib-permalinks',
@@ -118,7 +123,7 @@ module.exports = function(grunt) {
           }
         },
         dest: '<%= config.dist %>',
-        src: "!*.*"
+        src: '!*.*'
       }
     },
 
@@ -158,7 +163,7 @@ module.exports = function(grunt) {
     // CSS:
     concat: {
       options: {
-        separator: ';',
+        separator: ';'
       },
       dist: {
         src: [
@@ -171,21 +176,20 @@ module.exports = function(grunt) {
     },
     postcss: {
       options: {
-        map: true,
         map: {
           inline: false,
           annotation: '<%= config.dist %>/assets/css/maps/'
         },
         processors: [
           require('autoprefixer')({browsers: [
-            "Android 2.3",
-            "Android >= 4",
-            "Chrome >= 20",
-            "Firefox >= 24",
-            "Explorer >= 8",
-            "iOS >= 6",
-            "Opera >= 12",
-            "Safari >= 6"
+            'Android 2.3',
+            'Android >= 4',
+            'Chrome >= 20',
+            'Firefox >= 24',
+            'Explorer >= 8',
+            'iOS >= 6',
+            'Opera >= 12',
+            'Safari >= 6'
           ]}),
           require('cssnano')()
         ]
@@ -224,32 +228,44 @@ module.exports = function(grunt) {
       examples: {
         expand: true,
         cwd: '<%= config.src %>/data/examples',
-        src: ['**', '!build_examples/**' ],
+        src: ['**', '!build_examples/**'],
         dest: '<%= config.dist %>/assets/examples'
       },
+      contributor_docs: {
+        expand: true,
+        cwd: '<%= config.src %>/assets/contributor-docs',
+        src: '**',
+        dest: '<%= config.dist %>/contributor-docs'
+      },
       reference: {
         expand: true,
         cwd: '<%= config.src %>/data/reference',
         src: ['**'],
         dest: '<%= config.dist %>/assets/reference'
       },
       reference_assets: {
-        expand: true,
-        cwd: '<%= config.src %>/templates/pages/reference/',
-        src: ['**/!(*.hbs)'],
-        dest: '<%= config.dist %>/reference/'
-      },
-      reference_es: {
-        expand: true,
-        cwd: '<%= config.dist %>/reference',
-        src: ['**'],
-        dest: '<%= config.dist %>/es/reference'
-      },
-      reference_zh_Hans: {
-        expand: true,
-        cwd: '<%= config.dist %>/reference',
-        src: ['**'],
-        dest: '<%= config.dist %>/zh-Hans/reference'
+        files: (function() {
+          const cp = [];
+          pkg.languages.forEach(language => {
+            if (language === 'en') {
+              cp.push({
+                expand: true,
+                cwd: '<%= config.src %>/templates/pages/reference/',
+                src: ['**/!(*.hbs)'],
+                dest: '<%= config.dist %>/reference/'
+              });
+            } else {
+              cp.push({
+                expand: true,
+                cwd: '<%= config.src %>/templates/pages/reference/',
+                src: ['**/!(*.hbs)'],
+                dest: `<%= config.dist %>/${language}/reference/`
+              });
+            }
+          });
+
+          return cp;
+        })()
       },
       offlineReference: {
         files: [
@@ -298,7 +314,7 @@ module.exports = function(grunt) {
       default_options: {
         files: [
           {
-            prepend: "referenceData = ",
+            prepend: 'referenceData = ',
             input: '<%= config.src %>/templates/pages/reference/data.json',
             output: '<%= config.src %>/offline-reference/js/data.js'
           }
@@ -309,17 +325,36 @@ module.exports = function(grunt) {
     compress: {
       main: {
         options: {
-          archive: '<%= config.dist %>/offline-reference/p5-reference.zip',
+          archive: '<%= config.dist %>/offline-reference/p5-reference.zip'
         },
         expand: true,
         cwd: '<%= config.src %>/offline-reference',
         src: ['**/*'],
         dest: 'p5-reference/'
       }
+    },
+    htmllint: {
+      all: {
+        src: [
+          '<%= config.dist %>/**/*.html',
+          '!<%= config.dist %>/**/CHANGES.html',
+          '!<%= config.dist %>/**/README.html',
+          '!<%= config.dist %>/**/p5_featured/**/*.html',
+          '!<%= config.dist %>/**/learn/*.html',
+          '!<%= config.dist %>/**/examples/*.html'
+        ],
+        options: {
+          ignore: [
+            /^This document appears to be written in English/,
+            /^Bad value “https:/,
+            /^Consider adding a “lang” attribute to the “html”/
+          ]
+        }
+      }
     }
   });
 
-  grunt.registerTask('update-version', function(){
+  grunt.registerTask('update-version', function() {
     const done = this.async();
 
     const version = require('./src/templates/pages/reference/data.json').project.version;
@@ -341,6 +376,7 @@ module.exports = function(grunt) {
   grunt.loadNpmTasks('grunt-file-append');
   grunt.loadNpmTasks('grunt-contrib-compress');
   grunt.loadNpmTasks('grunt-contrib-requirejs');
+  grunt.loadNpmTasks('grunt-html');
 
   // multi-tasks: collections of other tasks
   grunt.registerTask('server', [
@@ -358,33 +394,31 @@ module.exports = function(grunt) {
   grunt.registerTask('optimize', [
     'newer:imagemin',
     'concat:dist',
-    // 'uncss',
     'postcss'
   ]);
 
   // i18n tracking task
-  grunt.registerTask('i18n', function(){
+  grunt.registerTask('i18n', function() {
     var done = this.async();
-    require("./i18n.js")(done);
+    require('./i18n.js')(done);
   });
 
-  // runs three tasks in order
+  // runs tasks in order
   grunt.registerTask('build', [
     'update-version',
     'exec',
     'clean',
+    'requirejs:yuidoc_theme',
     'requirejs',
     'copy',
-    'assemble',
     'optimize',
+    'assemble',
     'file_append',
     'compress',
-    'i18n'
+    'i18n',
+    'htmllint'
   ]);
 
   // runs with just grunt command
-  grunt.registerTask('default', [
-    'build'
-  ]);
-
+  grunt.registerTask('default', ['build']);
 };

README.md

@@ -4,17 +4,19 @@
 
 ## How To Contribute
 
-Known bugs and intended new features are tracked using [GitHub issues](https://github.com/processing/p5.js-website/issues). If you'd like to start working on an existing issue, comment on the issue that you plan to work on it so other contributors know it's being handled and can offer help. Once you have completed your work on this issue, [submit a pull request (PR)](https://github.com/processing/p5.js/blob/master/developer_docs/preparing_a_pull_request.md) against the p5.js master branch. In the description field of the PR, include "resolves #XXXX" tagging the issue you are fixing. If the PR addresses the issue but doesn't completely resolve it (ie the issue should remain open after your PR is merged), write "addresses #XXXX".
+Known bugs and intended new features are tracked using [GitHub issues](https://github.com/processing/p5.js-website/issues). If you'd like to start working on an existing issue, comment on the issue that you plan to work on it so other contributors know it's being handled and can offer help. Once you have completed your work on this issue, [submit a pull request (PR)](https://github.com/processing/p5.js/blob/master/contributor_docs/preparing_a_pull_request.md) against the p5.js master branch. In the description field of the PR, include "resolves #XXXX" tagging the issue you are fixing. If the PR addresses the issue but doesn't completely resolve it (ie the issue should remain open after your PR is merged), write "addresses #XXXX".
 
 If you discover a bug or have an idea for a new feature you'd like to add, begin by submitting an issue. Please do not simply submit a pull request containing the fix or new feature without making an issue first, we will probably not be able to accept it. Once you have gotten some feedback on the issue and a go ahead to address it, you can follow the process above to add the fix or feature.
 
 We recognize all types of contributions. This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. Add yourself to the [p5.js repository readme](https://github.com/processing/p5.js/blob/master/README.md#contributors) by following the [instructions here](https://github.com/processing/p5.js/issues/2309)!
 
+
 ## Setup
 
-0. Install [node.js](https://nodejs.org/en/download/).
-1. Download this repo as a [zip file](https://github.com/processing/p5.js-website/archive/master.zip) or [clone this repository](https://help.github.com/articles/cloning-a-repository/). 
-2. Navigate to the `p5.js-website` directory in the terminal and type `npm install`.
+0. Ensure Java is installed. Not installed?  Head over to https://java.oracle.com
+1. Install [node.js](https://nodejs.org/en/download/).
+2. Download this repo as a [zip file](https://github.com/processing/p5.js-website/archive/master.zip) or [clone this repository](https://help.github.com/articles/cloning-a-repository/). 
+3. Navigate to the `p5.js-website` directory in the terminal and type `npm install`.
 
 ## Running
 
@@ -44,7 +46,6 @@ Once you've setup the site, type `npm run watch` to run the website. This should
 
 If you've contributed to this website (or any other part of the p5.js project), add yourself [here](https://github.com/processing/p5.js#contributors). Instructions to do this can be found at the bottom of the section.
 
- 
 ## Etc
 * [Instructions for contributing to website translation/internationalization](https://github.com/processing/p5.js-website/blob/master/contributor_docs/i18n_contribution.md)
 * [Introducción a p5.js](https://github.com/processing/p5.js-getting-started-es) - The repository for the book and PDF production of [Introducción a p5.js](http://p5js.org/books/).

contributor_docs/Adding_examples.md

@@ -54,7 +54,7 @@ Examples help demonstrate different programming concepts and functionality of th
 4. [Grunt](https://gruntjs.com/) should now be installed, and you can use it to build the website by navigating to the top level directory and typing:
 
     ```bash
-    grunt server
+    npm run watch
     ```
 
 5. A local build of the p5js.org site should open in your web browser and you can navigate to the examples page to see your changes.