You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
3. This project is developed using [webpack](https://webpack.js.org/). Webpack is a module bundler that allows to "bundle" different files into one file. This allows you to write files for specific things and then mix them all together into one single file that you can import in your page.
22
22
23
-
Under the `/src` folder you will see that there are sub-folders for all ML5 methods. You can edit each file individually and then `build` everything into one single library.
23
+
Under the `/src` folder you will see that there are sub-folders for all ml5 methods. You can edit each file individually and then `build` everything into one single library.
24
24
25
25
Before `building` the library you can see if everything is working.
26
26
@@ -89,7 +89,7 @@ Create a new folder called `/experiments` in the project's root folder. Create a
89
89
90
90
```javascript
91
91
'use strict';
92
-
console.log('ML5 loaded');
92
+
console.log('ml5 loaded');
93
93
```
94
94
95
95
To something like this:
@@ -139,46 +139,7 @@ Create a new folder called `/experiments` in the project's root folder. Create a
139
139
140
140
## Running Unit Tests
141
141
142
-
143
-
144
-
## ML5 Website
145
-
146
-
The [ML5 website](https://ml5js.org/) is built with [Docusaurus](https://docusaurus.io/).
147
-
148
-
Docusaurus is an open-source library, built with React, to create and maintain documentation websites.
149
-
150
-
All the website content and documentation lives in the master branch but website is served from `gh-pages`.
151
-
152
-
### Contributing
153
-
154
-
Almost all the content for the website can be found in markdown under the `docs/` folder at the root level of the repository.
155
-
The naming convention we are using is the following:
156
-
157
-
* Examples are named: `examples-[name of example].md`
158
-
* API Reference files are named: `api-[Class].md`
159
-
* Glossary: `glossary-[type].md`
160
-
161
-
If you wish to help develop the website, first you'll need to install the necessary dependencies for Docusaurus.
162
-
163
-
From the root of the project run:
164
-
```
165
-
cd website
166
-
npm install
167
-
```
168
-
169
-
And then start the development server:
170
-
171
-
```
172
-
npm run start
173
-
```
174
-
175
-
This wil create a server that will reload whenever there are changes in the website source code.
0 commit comments