search

imodeljs / frontend-sample-showcase

MIT License
17 stars 9 forks source link

Annotations #219

Closed StefanRetief closed 3 years ago

StefanRetief commented 3 years ago

Added ability to start generating annotations. Annotations rely on two comments:

Using a webpack loader, the annotations will be generated around (not inclusive) the code specified. For example, if the desired code is on line 4-8, the comments should be placed on line 3 and 9. Upon compilation, the comments will not be removed from the code, but will be hidden within the editor on local host.

Once the annotations module of the editor is complete, the markdown should be fed to a react component that will parse out the steps and annotations as needed.

williamkbentley commented 3 years ago

We should probably add some documentation in CONTRIBUTING or README

StefanRetief commented 3 years ago

We should probably add some documentation in CONTRIBUTING or README

Added to CONTRIBUTING