p5.js website built using Node.js, Grunt, YAML and Assemble
Clone or download
lmccart Merge pull request #347 from AnimeshSinha1309/es6/structure
Updating Structure Examples to ES6 standards
Latest commit 7ad279a Jan 21, 2019

README.md

Build Status

p5js website

How To Contribute

Known bugs and intended new features are tracked using GitHub 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) 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 specification. Add yourself to the p5.js repository readme by following the instructions here!

Setup

  1. Install node.js.
  2. Download this repo as a zip file or clone this repository.
  3. Navigate to the p5.js-website directory in the terminal and type npm install.
  4. Copy dist\download\version-sample.json to dist\download\version.json.

Running

Once you've setup the site, type npm run watch to run the website. This should open a window in your browser with the site running at http://localhost:9000.

File structure

  • See note about what to include in pull requests here.
  • src/ – All the pieces for generating the built site. Edits should be made here.
    • assets/ – All static files (imgs, css, fonts, js, p5_featured homepage sketches)
      • Note: if you make edits here you must restart the server to see your changes. To see changes immediately, you can edit the assets files in the dist directory, but need to copy and paste your updated work here for it to be saved.
    • data/ – translation files
    • templates/
      • layouts/ – default.hbs is main page template
      • pages/ – Contains each of the pages of the p5 site, these get inserted in {{> body }} tag of default layout.
      • partials/ – These are reusable pieces that can get added to any page or layout, they correspond to other {{> filename }} tags in the pages or default layout.
  • dist/ – Where the rendered files are stored, this can be placed directly online.
  • Gruntfile.js – This file contains all the tasks for using assemble and YAML to generate the final, static site. It uses the taskrunner grunt.

Tools

  • Assemble is used to build a static site out of all the layouts and yml data.
  • grunt-assemble-i18n renders a set of pages for each language specified in the gruntfile, based on the handlebars templates and yml data. There is not a lot of documentation, but this example demonstrates the functionality well.
  • assemble-contrib-permalinks allows us to customize the permalinks (file structure of the rendered static site).

Add yourself to contributors!

If you've contributed to this website (or any other part of the p5.js project), add yourself here. Instructions to do this can be found at the bottom of the section.

Etc

Externally hosted language versions