Skip to content

DOC: on md vs ipynb #10

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.

Sign up for GitHub

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

Merged
danielballan merged 1 commit into from
May 11, 2025
Merged

DOC: on md vs ipynb #10

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,13 @@ for a good overview of what this is like to use.
- **[Jupyter Lite (beta)](https://scientific-python.github.io/executable-tutorials/jupyterlite/lab/index.html)** (works only on the basic executable example so far, missing dependencies for others)
- **[Binder](https://mybinder.org/v2/gh/scientific-python/executable-tutorials/notebooks)**

### Notes on the notebook file format

We do use MyST Markdown format for the notebooks, please visit [the upstream documentation](https://mystmd.org/guide/md-vs-ipynb) to learn more about the reasoning behind the choice.
However, we add it here that you can easily have the same user experience in JupyterLab if these two dependencies are installed:
- [jupytext library](https://pypi.org/project/jupytext/)
- [jupyterlab-myst JupyterLab extension](https://pypi.org/project/jupyterlab-myst/)


## Goals

Expand Down