search

ml5js / ml5-website-v02-docsify

This repository is a work-in-progress website, containing documentation and reference materials for the ml5.js library models.
https://docs.ml5js.org/
Other
0 stars 8 forks source link

readme

ml5.js Website on Docsify

This repository is for the work-in-progress ml5.js website, which is built using Docsify. It contains documentation and and reference materials for for the ml5.js library models.

Installation and Testing

You can simply clone the repository and run the website locally. The site is temporarily deployed to: https://ml5-next-gen-docs.netlify.app/.

Prerequisites

Contributing

We welcome contributions!

If you are in the ml5.js organization, create a new branch, keeping the naming convention described below. Please avoid using any other punctuation marks other than hyphens, "-". Category can be optional.

(category)/author-description-of-changes

If you are not in the ml5.js organization, follow these steps:

  1. Fork the repository and clone it to your local machine.
  2. Make changes.
  3. Commit your changes and push to the "main" branch on your forked repository.
  4. Create a new Pull Request (PR), by clicking on "Contribute" and then "Open Pull Request" on your forked repository.
  5. The PR will be reviewed and merged.

Issues

Please feel free to add any issues or feature requests on the Issues.

Code of Conduct

We believe in a friendly internet and community as much as we do in building friendly machine learning for the web. Please refer to our Code of Conduct for our rules for interacting with ml5 as a developer, contributor, or as a person using the library.

Acknowledgements

ml5.js is supported by the time and dedication of open source developers from all over the world. Funding and support is generously provided by a Google Education grant at NYU's ITP/IMA program and NYU Shanghai's IMA.