Improve README (#17)

* Add helper tag

* Fix source reference

* Add icons

* Update code-server README

* Update README for contributing

* Update README

* Improve readme

* Fix code-server without extensions
This commit is contained in:
Kyle Carberry
2023-09-19 13:22:04 -05:00
committed by GitHub
parent 77b2468bf5
commit a25b637c46
11 changed files with 106 additions and 21 deletions

View File

@@ -1,16 +1,15 @@
---
display_name: code-server
description: VS Code in the browser
icon: ../icons/code.svg
icon: ../.icons/code.svg
maintainer_github: coder
verified: true
tags: [helper]
tags: [helper, ide]
---
# code-server
Run [VS Code](https://github.com/Microsoft/vscode) on any machine anywhere and
access it in the browser.
Automatically install [code-server](https://github.com/coder/code-server) in a workspace, create an app to access it via the dashboard, install extensions, and pre-configure editor settings.
![Screenshot 1](https://github.com/coder/code-server/raw/main/docs/assets/screenshot-1.png?raw=true)
![Screenshot 2](https://github.com/coder/code-server/raw/main/docs/assets/screenshot-2.png?raw=true)
@@ -24,24 +23,24 @@ access it in the browser.
## Examples
### Extensions
### Pre-install Extensions
Automatically install extensions from [OpenVSX](https://open-vsx.org/):
Install the Dracula theme from [OpenVSX](https://open-vsx.org/):
```hcl
module "code-server" {
source = "https://registry.coder.com/modules/code-server"
extensions = [
"
"dracula-theme.theme-dracula"
]
}
```
Enter the `<author>.<name>` into the extensions array and code-server will automatically install on start.
### Settings
### Pre-configure Settings
Pre-configure code-server with settings:
Configure VS Code's [settings.json](https://code.visualstudio.com/docs/getstarted/settings#_settingsjson) file:
```hcl
module "settings" {

View File

@@ -3,7 +3,7 @@ terraform {
required_providers {
coder = {
source = "terraform.local/coder/coder"
source = "coder/coder"
version = ">= 0.12"
}
}

View File

@@ -17,6 +17,9 @@ CODE_SERVER="${INSTALL_PREFIX}/bin/code-server"
# Install each extension...
for extension in "$${EXTENSIONS[@]}"; do
if [ -z "$extension" ]; then
continue
fi
printf "🧩 Installing extension $${CODE}$extension$${RESET}...\n"
output=$($CODE_SERVER --install-extension "$extension")
if [ $? -ne 0 ]; then