Skip to content

Commit

Permalink
update mac vs code note
Browse files Browse the repository at this point in the history
  • Loading branch information
evanwill committed Aug 16, 2024
1 parent acf202a commit 9626f20
Showing 1 changed file with 4 additions and 7 deletions.
11 changes: 4 additions & 7 deletions docs/software/texteditor.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,25 +6,22 @@ nav_order: 2

# Get a Text Editor

Static web projects like CollectionBuilder are really just a folder of plain text files.
Static web projects like CollectionBuilder are just a folder of plain text files.
To edit them you will need a good text editor.
Code editors will allow you to work on whole folders of files at once (i.e. your Jekyll project repository) and have built in helpers for syntax highlighting, version control, terminals, search, and even spell check.

If you don't already have a favorite editor, the CollectionBuilder team suggests the very popular, open-source [Visual Studio Code](https://code.visualstudio.com/){:target="_blank" rel="noopener"} (VS Code).
Download VS Code and [follow their instructions](https://code.visualstudio.com/docs/setup/setup-overview) to install with the default options on your computer.
Then tweak the configuration options and extensions listed in the sections below.
(*note to Mac users: be sure to drag the VS Code app from your Downloads to Applications directory to ensure correct installation!*)

Next, tweak the configuration options and extensions listed in the sections below to better support working on your CB project.

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--however, any text editor will work!*
Many good alternatives exist--if you are looking for a VS Code clone minus Microsoft, check out [VS Codium](https://vscodium.com/) or [Theia IDE](https://theia-ide.org/#theiaide).
You can also use a light version of VS Code in your browser without installing anything by opening [vscode.dev](https://vscode.dev/).

*Note to Mac users:*
On macOS Sierra or later, VS Code automatically downloads to the Downloads directory, which can cause problems with updates down the road.
If this applies to you, after installation we recommend moving the VS Code app from Downloads to your Applications directory.
{:.alert .alert-blue}

## Configuring Visual Studio Code

VS Code is incredibly customizable via its settings.
Expand Down

0 comments on commit 9626f20

Please sign in to comment.