hex-grid-map-3D icon indicating copy to clipboard operation
hex-grid-map-3D copied to clipboard

Getting Started Documentation

Open chad-autry opened this issue 9 years ago • 3 comments

Add some more documentation on getting started.

  • Building/Editing the demo
  • npm
  • Adding new/custom DrawnItems
  • Handling Mouse Actions
  • Co-ordinate System

chad-autry avatar Aug 26 '16 10:08 chad-autry

Hi , demo is brilliant ! docs ,too. I wonder what tools did you use to generate the modules-struct and related api docs? It looks good , seems auto-generated..

alex2wong avatar Sep 07 '17 02:09 alex2wong

@alex2wong Thanks,

I used JSdoc with a customized template to generate my Angular/Bootstrap page.

Can see the build command in package.json, which also points out the embedded custom template.

"jsdoc": "jsdoc -t ./jsdoc-template -r ./src -d ./target/jsdoc"

Then the generated page is linked in gh-pages/src/app/app.js

app_jsdoc = require('../../../target/jsdoc/jsdoc'), //This is generated

It has been on the back burner to extract the template out as a separate project, but I've also switched from Angular to React so I'd want to switch that out at the same time.

chad-autry avatar Sep 07 '17 03:09 chad-autry

good, thanks. I will have a try : )

alex2wong avatar Sep 08 '17 02:09 alex2wong