Tools and frameworks

Docs are written in JSDoc

Documenting functions

You can document functions like

    /**
     * @param num {number} Just a number
     * @returns {number}
     */
    function test(num){
      return num;
    }
    

File segmentation

JSDoc supports both @Module and @Class syntax to organize the code.
Classes and Modules will appear in the top nav menu once they are declared

Writing tutorials

After you install the package(npm run init), a directory called "tutorials" is created in the root of the project

Building the docs