Skip to content
This repository was archived by the owner on Apr 19, 2021. It is now read-only.

Document .editorconfig as alternative to settings.json #1024

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion src/docs/config-editor.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,15 @@ Gitpod uses [Theia](https://github.com/eclipse-theia/theia) as its IDE which can

Workspace settings are stored in a file within your project. They can reside either in:
- `$GITPOD_REPO_ROOT/.theia/settings.json` or
- `$GITPOD_REPO_ROOT/.vscode/settings.json`
- `$GITPOD_REPO_ROOT/.vscode/settings.json` or
- `$GITPOD_REPO_ROOT/.editorconfig`

User settings override workspace settings and can be configured through the preferences editor, which you can open through the menu (`File -> Preferences`).

The available properties and their possible values are proposed in the editor and are the same as in VS Code.

Additionally you can keep settings in [`editorconfig` format](https://editorconfig.org) that takes precedence over other settings.

<h2 class="h3">Example Configuration</h2>

File `settings.json` follows JSON syntax as follows:
Expand Down