diff --git a/README.md b/README.md index fe4fece0..7d349983 100644 --- a/README.md +++ b/README.md @@ -34,6 +34,14 @@ Images and real-life data make text more engaging and powerful, but be sure what you use is appropriately licensed and available. Here again, even a rough idea for artwork can be polished by others. +The NumPy tutorials are a curated collection of +[MyST-NB](https://myst-nb.readthedocs.io/) notebooks. These notebooks are used +to produce static websites and can be opened as notebooks in Jupyter using +[Jupytext](https://jupytext.readthedocs.io). + +> __Note:__ You should use [CommonMark](https://commonmark.org) markdown +> cells. Jupyter only renders CommonMark. + ### Why Jupyter Notebooks? The choice of Jupyter Notebook in this repo instead of the usual format @@ -42,20 +50,25 @@ used in the main NumPy documentation has two reasons: * Jupyter notebooks are a common format for communicating scientific information. + * Jupyter notebooks can be launched in [Binder](https://www.mybinder.org), so that users can interact + with tutorials * rST may present a barrier for some people who might otherwise be very interested in contributing tutorial material. #### Note -You may notice that some of our content is in markdown format (`.md` files). -This is part of an ongoing restructuring of the repository workflow. However, -you can still submit your content as a Jupyter Notebook file. +You may notice our content is in markdown format (`.md` files). We review and +host notebooks in the [MyST-NB](https://myst-nb.readthedocs.io/) format. We +accept both Jupyter notebooks (`.ipynb`) and MyST-NB notebooks (`.md`). If you want +to sync your `.ipynb` to your `.md` file follow the [pairing +tutorial](content/pairing.md). ### Adding your own tutorials If you have your own tutorial in the form of a Jupyter notebook (a `.ipynb` file) and you'd like to add it to the repository: + #### Create an issue Go to [https://github.com/numpy/numpy-tutorials/issues](https://github.com/numpy/numpy-tutorials/issues) @@ -71,8 +84,6 @@ your content consistent with our existing tutorials. #### Upload your content -Remember to clear all outputs on your notebook before uploading it. -