Skip to content

Latest commit

 

History

History
25 lines (15 loc) · 829 Bytes

README_docs.md

File metadata and controls

25 lines (15 loc) · 829 Bytes

ODS Widgets documentation generation

Introduction

Docs are being generated from in-code comments written in ngdoc, a flavour of jsdoc.

Links:

Config

A working setup to generate the documentation

  • Node version v8.17.0
  • NPM version 6.13.4
  • Grunt version grunt-cli v1.4.3 grunt v1.0.3

Generating docs

Once your ndocs are written, ensure npm modules are properly installed (npm install) and then simply run grunt ngdocs.

You can then run the server grunt server and access the documentation from localhost:9001/docs