From f8ccbf6657b3434c13fad3c47e7eb32251ad7490 Mon Sep 17 00:00:00 2001 From: Caspar Jungbacker Date: Sun, 26 Feb 2023 18:04:45 +0100 Subject: [PATCH] Add VS Code setup instructions --- book/_toc.yml | 1 + book/vscode-setup.md | 15 +++++++++++++++ 2 files changed, 16 insertions(+) create mode 100644 book/vscode-setup.md diff --git a/book/_toc.yml b/book/_toc.yml index 0d8634e..8e14481 100644 --- a/book/_toc.yml +++ b/book/_toc.yml @@ -5,3 +5,4 @@ parts: - caption: Installation and Setup chapters: - file: git-setup + - file: vscode-setup diff --git a/book/vscode-setup.md b/book/vscode-setup.md new file mode 100644 index 0000000..e1681b0 --- /dev/null +++ b/book/vscode-setup.md @@ -0,0 +1,15 @@ +# 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 + +These are some very useful extensions when working on Jupyter Books: + +- [Python](https://marketplace.visualstudio.com/items?itemName=ms-python.python) - for obvious reasons. Also includes Jupyter Notebook rendering. +- [MyST-Markdown](https://marketplace.visualstudio.com/items?itemName=ExecutableBookProject.myst-highlight) - adds support for MyST markdown, including previews. +- [YAML](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml) - enables validation of `.yml` files (the format of the Jupyter Book configuration files). \ No newline at end of file