manual_teachbooks/book/installation-and-setup/vscode-setup.md
2025-04-01 15:00:43 +02:00

27 lines
No EOL
1.5 KiB
Markdown

````{margin}
```{admonition} User types
:class: tip
This page is useful for user type 4 and 5.
```
````
# Editing text: VS Code
VS Code is a text editor with some extra features, such as integrated source control and a file browser. Moreover, extensions are available to add functionality to VS Code.
## Installation
VS Code can be downloaded from [here](https://code.visualstudio.com). The installation is fairly simple and won't be covered here.
## Extensions
When working with Jupyter Book (or Notebooks in general), these extensions are highly recommended:
- User type 4-5:
- [MyST-Markdown](https://marketplace.visualstudio.com/items?itemName=ExecutableBookProject.myst-highlight) - adds support for MyST markdown, including previews.
- [Spell checker](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker) - Spelling checker for source code and text
- User type 5
- [YAML](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml) - enables validation of `.yml` files (the format of the Jupyter Book configuration files).
- [Python](https://marketplace.visualstudio.com/items?itemName=ms-python.python) - for obvious reasons. Also includes Jupyter Notebook rendering.
- [GitHub Copilot](https://marketplace.visualstudio.com/items?itemName=GitHub.copilot) - Your AI pair progammer
- [Jupyter Cell Tags](https://marketplace.visualstudio.com/items?itemName=ms-toolsai.vscode-jupyter-cell-tags) - Jupyter Cell Tags support