📓 Add ipynb as export format

[rowanc1]

cc @mmcky

To Do

• Fix redundant +++ markers in Markdown cells.

[changeset-bot]

🦋 Changeset detected

Latest commit: f39daf0

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 9 packages

Name	Type
myst-frontmatter	Patch
myst-to-ipynb	Patch
myst-cli	Patch
myst-common	Patch
myst-config	Patch
myst-spec-ext	Patch
myst-to-md	Patch
mystmd	Patch
myst-migrate	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[mmcky]

thanks @rowanc1. I will check this branch out and give it a go tomorrow.

[choldgraf]

This would be really useful for educational use cases in general. It's something many people have requested! Especially if:

1. it is possible for some cells to not show up in the output notebooks.
2. If launch buttons etc can launch the built notebooks instead of the source notebooks.

I don't think either of those should block this, just noting commonly requested functionality if it is helpful. People often want this to separate teacher and student copies of things.

I bet there is an issue in jupyter book we can link this against. (On phone now so it is hard to look)

[mmcky]

agree @choldgraf. Some form of state based code-cells (enabling student and teacher (solution) notebook versions) is a super useful feature for education. I'll search through the issues and/or open one to track this use case.

[kp992]

Thanks for the putting this together. I am happy to help in completing this feature.

[choldgraf]

Just noting there was some discussion on the jupyter-education listserv today of folks asking whether it was possible to generate notebooks from "teacher copies" which reminded me of this feature.

[nthiery]

Is one of the use case in mind to regenerate the notebook in a book with cross links resolved and the like? That would be quite useful indeed!

With that in mind, I would suggest to also enable -- in this PR or a followup -- exporting text-based notebooks (e.g. in jupytext myst:md format). These are super handy in certain contexts -- especially in the aforementioned context of education.

[mmcky]

thanks for pushing this froward @agoose77 -- let me know if I can help with any testing? We are building out our first switch over QuantEcon/lecture-python-programming#345 and will use this feature as soon as its ready to go to build notebooks compatible with colab etc.

[agoose77]

Thanks @mmcky,

I've not looked at this too closely for a while; mainly I've merged the other PR into this one so that we have a single point of review.

Given that this PR effectively connects myst-to-md with a notebook adaptor, it's already likely fairly usable subject to any bugs in myst-to-md. I'd therefore be really keen to hear of your experience in using it. Are you familiar with building a custom version of MyST for testing? I can alternatively build a custom .cjs file for you to run with Node.js.

[mmcky]

thanks @agoose77

I'd therefore be really keen to hear of your experience in using it. Are you familiar with building a custom version of MyST for testing? I can alternatively build a custom .cjs file for you to run with Node.js.

I am not familiar with that -- is there a place in the docs? Happy to learn.

[kp992]

Thanks @agoose77. I am planning to test myst-to-ipynb by using:

downloads:
  - file: exports/some_file.ipynb
    title: IPython Notebook

Can you please guide on how can I do that?