Skip to content

Instantly share code, notes, and snippets.

@JetStarBlues

JetStarBlues/p5Workflow.md

Last active February 21, 2022 03:46
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save JetStarBlues/d95510fc8632a86ad2bb85cd79951a82 to your computer and use it in GitHub Desktop.
Save JetStarBlues/d95510fc8632a86ad2bb85cd79951a82 to your computer and use it in GitHub Desktop.
Download ZIP
p5 Contribution Workflow
Raw
p5Workflow.md

Core (p5.js)

Modifying p5 Documentation

  1. Generate a p5.min.js file containing changes via npm run grunt

  2. Add the new p5.min.js file to the docs directory by using ./copyfiles.sh

  3. Steps 1 & 2 can be done as one-liner: npm run grunt && ./copyfiles.sh

  4. Preview docs:

    1. cd docs/reference
    2. Start a server here by python3 -m http.server
      • Note: make sure to start a server only after running npm run grunt at least once. If docs/reference is empty, starting a sever might fail with a "FileNotFoundError"

copyfiles.sh

#!/bin/bash

cp lib/p5.min.js docs/reference/assets/js/p5.min.js

Website (p5.js-website)

TODO

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment