Skip to content

Latest commit

 

History

History
9 lines (5 loc) · 669 Bytes

CONTRIBUTING.md

File metadata and controls

9 lines (5 loc) · 669 Bytes

Generating documentation

Documentation is automatically generated via GitHub action "fundoc" and published to GitHub Pages. You don't need to commit it when working on the repo.

To generate documentation locally for test purposes you'll need to install fundoc first. Then you can run fundoc or yarn build in the project root.

To automatically generate documentation on files change consider configuring file watcher in your IDE. Example configuration for WebStorm:

image