Began adding documentation to project

UoA-eResearch / research-hub-web

Research Hub Web

https://research-hub.cer.auckland.ac.nz

MIT License

3 stars 2 forks source link

Closed Hganavak closed 5 years ago

Hganavak commented 5 years ago

Added dependency and script for compodoc documentation generator

Hganavak commented 5 years ago

Added compodoc support to the project
Updated the README with compodoc instructions
Compodoc documentation can be regenerated by running npm run compodoc
Compodoc generates static HTML files. These can be viewed either:
- Directly from GitHub using raw page renderers
- Locally, by opening the documentation/*.html files in your browser
For information on adding JSDoc markup to your source code see here