Skip to content

Commit

Permalink
vs code persistent sessions note
Browse files Browse the repository at this point in the history
  • Loading branch information
evanwill committed Nov 3, 2023
1 parent 3f59e09 commit c8ebd6c
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions docs/software/texteditor.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,12 @@ If you don't already have a favorite editor, the CollectionBuilder team suggests
Download VS Code and use their wizard to install with the default options on your computer.

If you are unfamiliar with editors, there is pretty good [VS Code documentation](https://code.visualstudio.com/docs) including videos and reference, but you will learn a lot just working through you CB project!
These docs will often reference VS Code.

## Configuring Visual Studio Code

Visual Studio Code (VS Code) has a tremendous number of extensions that can be added to enhance its functionality.
We recommend:
VS Code has a tremendous number of extensions that can be added to enhance its functionality.
For working on CollectionBuilder projects we recommend:

- [Code Spell Checker](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker){:target="_blank" rel="noopener"}, which will check your spelling.
- [Rainbow CSV](https://marketplace.visualstudio.com/items?itemName=mechatroner.rainbow-csv){:target="_blank" rel="noopener"}, highlights CSVs to make them easier to read.
Expand All @@ -27,9 +28,12 @@ VS Code is incredibly customizable via its settings as well.
To configure the editor, click the *gear icon* in the bottom left corner of the VSCode window and choose *Settings*.
The searchable *Settings* pane has information about all the configuration options.

When you first install VS Code, the default settings can be distracting, so **don't be afraid to turn things off!**
When you first install VS Code, the default settings can be distracting and overwhelming, so **don't be afraid to turn things off!**

Finally, if you are on Windows, you will want to configure your built in terminal to use Git Bash (rather than Power Shell).
Importantly, if you are on Windows, you will want to configure your built in terminal to use Git Bash (rather than Power Shell).
Open the build in terminal window using Ctrl + backtick (that little character next to the "1" key).
A dropdown is available on the upper left of the terminal pane to switch your terminal.
Set it to use Git Bash as default to ensure you can use Jekyll correctly.

Finally, we have found that the recently added "persistent sessions" feature tends to cause mysterious issues with Jekyll server, so we suggest turning it off.
In Settings, search for "persistent", then uncheck the option "Terminal > Integrated: Enable Persistent Sessions".

0 comments on commit c8ebd6c

Please sign in to comment.