admin2/manual_teachbooks
1
0
Fork 0
mirror of https://github.com/TeachBooks/manual.git synced 2026-11-13 06:45:52 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
manual_teachbooks/book/installation-and-setup/vscode-setup.md
Tom van Woudenberg f44ac6bbdd Added user types, restructured sollaborative book-editing
2024-04-11 12:28:44 +02:00

2.4 KiB
Raw Blame History

VS Code

:class: tip
This page is useful for user type 4-6.

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. 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-6:
  • User type 5-6
    • YAML - enables validation of .yml files (the format of the Jupyter Book configuration files).
    • Python - for obvious reasons. Also includes Jupyter Notebook rendering.
    • GitHub Copilot - Your AI pair progammer
    • Jupyter Cell Tags - Jupyter Cell Tags support

Using the Terminal in VS Code (Windows only), user type 5-6 only

By default, Powershell is the default terminal used in VS Code. However, Git Bash is recommended because it provides Unix-like commands, making it much easier to find help on sites like Stack Exchange. It also works better with open source projects like Jupyter. Git Bash installs automatically with git which you'll learn in the next chapter; to set as default:

  • Type Ctrk+Shift+P to open the command palette (it's also the top item in the "View" menu list)
  • Start type "terminal default" and you will soon see and be able to select the setting "Terminal: Select Default Profile" (hit Enter)
  • select Git Bash and hit "Enter" again to set as default

When creating a new terminal via the menu bar you should now automatically start with a Git Bash terminal. Note that if a Powershell terminal still opens by default, you can always create a new terminal and manually select Git Bash.