diff --git a/packages/projects-docs/pages/learn/editors/web/_meta.json b/packages/projects-docs/pages/learn/editors/web/_meta.json index 36b8358d..383c4a2e 100644 --- a/packages/projects-docs/pages/learn/editors/web/_meta.json +++ b/packages/projects-docs/pages/learn/editors/web/_meta.json @@ -2,5 +2,6 @@ "overview": "Overview", "commandpalette": "Command Palette", "shortcuts": "Keyboard Shortcuts", - "themes": "Themes" + "themes": "Themes", + "vscode-web": "VS Code Web" } diff --git a/packages/projects-docs/pages/learn/editors/web/vscode-web.mdx b/packages/projects-docs/pages/learn/editors/web/vscode-web.mdx new file mode 100644 index 00000000..6b8df8fa --- /dev/null +++ b/packages/projects-docs/pages/learn/editors/web/vscode-web.mdx @@ -0,0 +1,58 @@ +--- +title: VS Code Web +description: Introduction to a customized version of VS Code for the web with built-in CodeSandbox features. +--- + +import { Callout } from 'nextra-theme-docs' + +# VS Code for the web + +Productivity is key when working in an editor. For this reason, we have embedded our CodeSandbox features within the powerful and well loved VS Code. + +The web editor looks and functions like VS Code for the web, with a few built-in CodeSandbox tools. + +![vs code web layout](../../images/vscode-web-overview.png) + +The activity bar holds all the tools for managing your developer experience. The web editor will always contain the standard VS Code tools, namely the File explorer, Search, Source Control, Run and Debug and the Extension marketplace. + +The web editor also comes with a CodeSandbox Devtool extension which provides access to all the unique Code Sandbox features (more on that later). + +In the Terminal panel, you can see all the running tasks, private terminals, and shared terminals (managed by CodeSandbox). + +While the layout is entirely customizable, the standard layout opens previews, and support tools like documentation and setup tools in the right editor panel. + +## Things to know when switching over + +All CodeSandbox DevTools, such as previews, tasks, and shared terminals, are now nested under the “CodeSandbox DevTools” panel on the left sidebar. From there, you can manage all these DevTools when needed, but most of these actions will still be performed automatically, just like before. For example, if your project has a task configured that runs the dev server on VM startup, it will automatically open the preview for you when you open the project. + +## Tasks, Terminals and Previews + +Preview ports, Tasks and shared terminals are controlled through the devtool extension in the sidebar. + +![CSB devtool](../../images/vscode-web-devtools.png) + +**Tasks** + +Tasks set in the `tasks.json` file will be listed in the Devtool extension. Here you can see all the tasks, run, stop or restart the tasks. + +**Previews** + +Tasks that spin up previews will be accessible in a port listed under `Previews` + +You can also see the list of ports in the terminal panel under `Ports` + +![Ports](../../images/vscode-web-ports.png) + +**Terminals** + +There are three types of terminals: + +1. Native terminal: This is managed by VS Code when you open a terminal. It is a private terminal to you that others don’t see. + +2. Tasks: These are run by Pitcher, an internal CodeSandbox service. The output of a task is streamed to a terminal window and displayed as a VS Code task so it is easily distinguishable from a terminal. + + ![Tasks](../../images/vscode-web-tasks.png) + +3. Shared terminal: In the sidebar, you can open a shared terminal. This terminal is managed by Pitcher, allowing others to see it. + + ![shared terminals](../../images/vscode-web-shared-terminal.png) diff --git a/packages/projects-docs/pages/learn/images/vscode-web-devtools.png b/packages/projects-docs/pages/learn/images/vscode-web-devtools.png new file mode 100644 index 00000000..ae555f8c Binary files /dev/null and b/packages/projects-docs/pages/learn/images/vscode-web-devtools.png differ diff --git a/packages/projects-docs/pages/learn/images/vscode-web-overview.png b/packages/projects-docs/pages/learn/images/vscode-web-overview.png new file mode 100644 index 00000000..798c074c Binary files /dev/null and b/packages/projects-docs/pages/learn/images/vscode-web-overview.png differ diff --git a/packages/projects-docs/pages/learn/images/vscode-web-ports.png b/packages/projects-docs/pages/learn/images/vscode-web-ports.png new file mode 100644 index 00000000..30fa5e53 Binary files /dev/null and b/packages/projects-docs/pages/learn/images/vscode-web-ports.png differ diff --git a/packages/projects-docs/pages/learn/images/vscode-web-shared-terminal.png b/packages/projects-docs/pages/learn/images/vscode-web-shared-terminal.png new file mode 100644 index 00000000..62929142 Binary files /dev/null and b/packages/projects-docs/pages/learn/images/vscode-web-shared-terminal.png differ diff --git a/packages/projects-docs/pages/learn/images/vscode-web-tasks.png b/packages/projects-docs/pages/learn/images/vscode-web-tasks.png new file mode 100644 index 00000000..4af01f2d Binary files /dev/null and b/packages/projects-docs/pages/learn/images/vscode-web-tasks.png differ