diff --git a/docs/installation.md b/docs/installation.md index aa4fe0b6a..731c37adc 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -1,6 +1,7 @@ This page walks you through installation options for Posit Publisher. ## Installation for VSCode / Positron + The VSCode extension package includes everything you need to get started within VSCode or Positron. diff --git a/docs/vscode.md b/docs/vscode.md new file mode 100644 index 000000000..6999890fa --- /dev/null +++ b/docs/vscode.md @@ -0,0 +1,36 @@ +# VSCode Extension + +## Quick Start + +Install the extension. +[https://cdn.posit.co/publisher/releases/tags/v0.0.alpha2/publisher-0.0.alpha2.vsix](https://cdn.posit.co/publisher/releases/tags/v0.0.alpha2/publisher-0.0.alpha2.vsix). + +To learn how to install a `.vsix` file, see the [*Install from a VSIX*](https://code.visualstudio.com/docs/editor/extension-marketplace#_install-from-a-vsix) guide from Visual Studio Code. + +## Tutorial + +Once installed, open *Posit Publisher* by clicking the icon in the editor menu bar. This will open the *Posit Publisher* UI. + +See [./ui.md](./ui.md) for additional instructions. + +![](https://cdn.posit.co/publisher/assets/img/tutorial.png) + +## Command Pallette Commands + +### Posit: Open Publisher + +This command opens *Posit Publisher* in a new window or focuses on an existing window. + +This command invokes the same action as clicking the *Posit Publisher* icon. + +### Posit: Close Publisher + +This command closes *Posit Publisher* and shuts down the server. + +## Configuration + +### `posit.publisher.executable.path` + +By default, the extension uses the bundled Posit Publisher binary executable. To override this behavior, configure the `posit.publisher.executable.path` property in your *User* or *Workspace* settings. + +![](https://cdn.posit.co/publisher/assets/img/settings.png) diff --git a/extensions/vscode/README.md b/extensions/vscode/README.md index 67a53154b..f89a56970 100644 --- a/extensions/vscode/README.md +++ b/extensions/vscode/README.md @@ -21,18 +21,14 @@ This command opens *Posit Publisher* in a new window or focuses on an existing w This command invokes the same action as clicking the *Posit Publisher* icon. -When opening *Posit Publisher* for the first time, a background process is started on your machine. To shut down the background process, invoke the *Posit: Close Publisher* command. - ### Posit: Close Publisher -This command closes *Posit Publisher* and shuts down the corresponding background process. +This command closes *Posit Publisher* and shuts down the server. ## Configuration ### `posit.publisher.executable.path` -If the Posit Publisher executable doesn't exist on `PATH`, the location may be manually configured using this setting. - -Configure the `posit.publisher.executable.path` property in your *User* or *Workspace* settings. +By default, the extension uses the bundled Posit Publisher binary executable. To override this behavior, configure the `posit.publisher.executable.path` property in your *User* or *Workspace* settings. ![](https://cdn.posit.co/publisher/assets/img/settings.png)