Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add "launch" link and "download ipynb" functionality for myst notebooks #124

Open
choldgraf opened this issue Apr 3, 2020 · 4 comments
Open
Labels
enhancement New feature or request

Comments

@choldgraf
Copy link
Member

Currently we have two features that make a hard assumption about the input file extension being ipynb:

IPYNB downloading:

image

and Launch Links:

image

We should add in some logic to check whether the input file is a MyST notebook file, and add these in for those.

For the launch links, we will also need to add documentation to users to tell them how they can configure their repositories to open MyST notebooks with jupytext automatically at launch so they show up as proper notebooks

@choldgraf choldgraf added the enhancement New feature or request label Apr 3, 2020
@jstac
Copy link
Member

jstac commented Apr 3, 2020

I would have thought that we always want to offer ipynb files for download, in their executed form, and not bother offering md files at all.

For your average reader (e.g., student in a data 8 course), a myst file will mean little to them. But an executed ipynb will be valuable.

Those who want a myst file will probably be relatively tech-savvy and can convert via Jupytext.

The other related point is that @gregcaporaso and others point out that we have links to source so that readers can easily open PRs. In which case they have access to the myst files anyway.

@choldgraf
Copy link
Member Author

choldgraf commented Apr 3, 2020

sure thing - it's just that the actual raw source files are already downloadable so if we wanted to only let people download ipynb files it would actually mean we need to remove some functionality. Is this what you're suggesting?

Alternatively, we could only offer ipynb download for the MyST notebooks, but not for "regular" myst markdown documents.

@jstac
Copy link
Member

jstac commented Apr 4, 2020

if we wanted to only let people download ipynb files it would actually mean we need to remove some functionality. Is this what you're suggesting?

I'm just saying that, IMO, we should emphasize ipynb downloads over md downloads. So, in the pic at the top of this issue, you have "md" and "pdf" as the two download options in the drop-down menu. I suggest "ipynb" and "pdf".

@choldgraf
Copy link
Member Author

sure thing - I agree, but I can't take a picture of the ipynb download because it doesn't exist yet :-)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants