Skip to content

Commit

Permalink
docs: adds VSCode extension instructions (#925)
Browse files Browse the repository at this point in the history
  • Loading branch information
tdstein authored Jan 31, 2024
1 parent 7bb7316 commit 836b0bc
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 6 deletions.
1 change: 1 addition & 0 deletions docs/installation.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
36 changes: 36 additions & 0 deletions docs/vscode.md
Original file line number Diff line number Diff line change
@@ -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)
8 changes: 2 additions & 6 deletions extensions/vscode/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

0 comments on commit 836b0bc

Please sign in to comment.