itk-vtk-viewer icon indicating copy to clipboard operation
itk-vtk-viewer copied to clipboard

Interactive docs for itk-vtk-viewer

Open oeway opened this issue 5 years ago • 3 comments

For the ImJoy tutorial at I2K workshop, I added support for running imjoy plugin code (JS and Python) directly in the tutorial site, just like Jupyter notebook but without the hassle to install locally or wait to spin up the binder server. I am thinking that maybe we can also add that into the docs of itk-vtk-viewer.

I used docsify, which is a static site generator runs on the client side, we just need to place markdown files along with an html file.

As a reference, this is an interactive docs for Kaibu api: https://kaibu.org/docs/#/api We might want to implement it differently, but the idea is to load imjoy-core to the docs page. We can do that in the current static site, or as an easy alternative, use the same static files as Kaibu here.

oeway avatar Dec 04 '20 08:12 oeway

FYI: We have now documented the docsify+imjoy solution for interactive documentation: https://imjoy-team.github.io/imjoy-docs/

oeway avatar Dec 10 '20 16:12 oeway

@oeway beautiful job on the I2K tutorial! :medal_sports:

The docsify support is more awesomeness! I am excited to try it on a few projects.

For the itk-vtk-viewer, is it possible to use the imjoy + run + edit features in the current static site?

thewtex avatar Dec 15 '20 15:12 thewtex

Thank you!

Yes, not right away but it should be easy to just load ImJoy core to the page with the loader, then add the button to trigger the execution of code. I have limited bandwidth right now, but I think we can get it to work with in one or two hours. It would be awesome to combine with the multi-scale api, perhaps write an interactive blog for introducing this new feature and api.

oeway avatar Dec 17 '20 13:12 oeway