Skip to content

Commit

Permalink
Update the noteboooks/index.md to have ToC first and link to notebook…
Browse files Browse the repository at this point in the history
…_setup (#34)
  • Loading branch information
psobolewskiPhD authored Oct 18, 2024
1 parent a373e1e commit d9224f0
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions napari-workshops/notebooks/index.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,18 @@
# Notebooks

```{note}
We encourage you to follow along with your own, fresh notebook, using the executed and rendered notebooks included in this repository only as a guide.

## Rendered notebooks

```{tableofcontents}
```

````{note}
In this repository, all notebooks have been converted to MyST Markdown files
(with a `.md` extension) since this format is easier to visualize on GitHub.
This also makes it easier to view differences between versions of the notebooks
on the GitHub interface. To open these files as Jupyter Notebooks, you need to
have the Jupytext package installed (this will be installed automatically if you
run `python -m pip install -r requirements.txt` or
`conda create -f environment.yml` from this repository as outlined in [](../installation).)
have the Jupytext package installed, see [the notebook setup page.](../notebook_setup).)
In the Jupyter notebook interface, if you right-click any of the `.md` files in
this folder now, you should see an option that says "Open with -> Notebook"
Expand All @@ -21,9 +26,4 @@ jupytext --to ipynb <notebook_file>.md
```
in the command line.
```

## Contents

```{tableofcontents}
```
````

0 comments on commit d9224f0

Please sign in to comment.