jupyter / nbviewer

nbconvert as a web service: Render Jupyter Notebooks as static web pages
https://nbviewer.jupyter.org
Other
2.21k stars 548 forks source link

Add optional "red pen" to nbviewer #11

Open embray opened 11 years ago

embray commented 11 years ago

We're using IPython Notebook for teaching and having students do their homework in it. It would be kind of awesome to be able to write directly on the notebook without having to print it out. I was thinking some sort of SVG overlay, which is something I've done before. This would work especially nicely on tablets that support it.

Originally I thought of suggesting this for going directly into the notebook, but it was quickly pointed out that, as the contents of the notebook can change, there's no good way for markup to change with it. So keeping markup with a static rendering a la nbviewer seems to be the way to go.

I'm interested in working on this myself in my own fork, but I've heard mention that some sizable changes are afoot in @Carreau's fork so I guess there are questions as to where to begin if this is even something desirable at all.

Carreau commented 11 years ago

I kind of have hundreds of things to do. So feel free to advance on nbviewer if you wish.

The "big change" is that nbviewer rely on a modified version on nbconvert which is hard to maintain. So I don't want people hacking thing that potentially will get a big rewrite.

ANd I won't be doing big rework while nbconvert is not ready to be integrated as a library.

I can guide you to deploy your own version of nbviewer if you wish. (instruction here)

I have no idea on how to "overlay" something onto the notebook. But if you are able to do that, we could always find a way to have a per-cell overlay.

May I suggest you get get a look at

http://literallycanvas.com/ https://github.com/literallycanvas/literallycanvas

(haven't tried it though)

takluyver commented 11 years ago

By the sounds of it, an important target is making the stock nbconvert suitable for use in nbviewer?

On 12 December 2012 22:16, Bussonnier Matthias notifications@github.comwrote:

I kind of have hundreds of things to do. So feel free to advance on nbviewer if you wish.

The "big change" is that nbviewer rely on a modified version on nbconvert which is hard to maintain. So I don't want people hacking thing that potentially will get a big rewrite.

ANd I won't be doing big rework while nbconvert is not ready to be integrated as a library.

I can guide you to deploy your own version of nbviewer if you wish. (instruction here https://github.com/Carreau/nbviewer/issues/3)

I have no idea on how to "overlay" something onto the notebook. But if you are able to do that, we could always find a way to have a per-cell overlay.

May I suggest you get get a look at

http://literallycanvas.com/ https://github.com/literallycanvas/literallycanvas

(haven't tried it though)

— Reply to this email directly or view it on GitHubhttps://github.com/ipython/nbviewer/issues/11#issuecomment-11312355.

embray commented 11 years ago

Thanks; when I get to this I'll poke you if I have any deployment issues but it looks straightfoward enough. Obviously the details of this feature are still pretty half-baked, though I have a soup of ideas. So I will update the issue as more details come to light. In the meantime, if the main changes you're working on are on the nbconvert end it doesn't sound like this will get in the way much?

This isn't a high priority either but I wanted to put it out there somewhere so that it doesn't fall off my todo list completely.

Carreau commented 11 years ago

Please have a look at https://github.com/ptone/nbcast

Maybe you even have something to do with it...

rgbkrk commented 10 years ago

nbviewer has had a major refactor, so if you're still insterested in this feature @embray you'll probably want to visit it again.

There have been ruminations on integrating with some collaboration suites, but I don't know what the status of those is.

minrk commented 10 years ago

hypothesis is working on annotations for the web, it's probably a good place to start.

embray commented 10 years ago

Yes, this is still something worth looking into, though I haven't had the time (and was waiting on that nbviewer refactor ;)

jdavidheiser commented 7 years ago

I know this is a pretty old issue, but wanted to chime in that I think this is an excellent idea. We are toying with different ways to do "code reviews" for the content of notebooks (both the code and the output), and direct annotation of a specific version of the document would be really nice.