Merge pull request #830 from quantified-uncertainty/vscode-extension-documentation
tweak: Better documentation
This commit is contained in:
commit
742b67d5bd
|
@ -1,21 +1,35 @@
|
||||||
# Squiggle For VS Code
|
# Squiggle For VS Code
|
||||||
|
|
||||||
_[marketplace](https://marketplace.visualstudio.com/items?itemName=QURI.vscode-squiggle)_
|
## About
|
||||||
|
|
||||||
This extension provides support for [Squiggle](https://www.squiggle-language.com/) in VS Code.
|
This extension provides support for [Squiggle](https://www.squiggle-language.com/) in VS Code. It can be found in the VS code _[marketplace](https://marketplace.visualstudio.com/items?itemName=QURI.vscode-squiggle)_
|
||||||
|
|
||||||
Features:
|
Features:
|
||||||
|
|
||||||
- Preview `.squiggle` files in a preview pane
|
- Preview `.squiggle` files in a preview pane
|
||||||
- Syntax highlighting for `.squiggle` and `.squiggleU` files
|
- Syntax highlighting for `.squiggle` and `.squiggleU` files
|
||||||
|
|
||||||
# Configuration
|
## Installation
|
||||||
|
|
||||||
Some preview settings, e.g. whether to show the summary table or types of outputs, can be configurable on in the VS Code settings and persist between different preview sessions.
|
You can install this extension by going to the "extensions" tab, searching for "Squiggle", and then installing it.
|
||||||
|
|
||||||
|
![](./images/vs-code-install.png)
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
After loading a `.squiggle` file, an "Open Preview" button will appear. If you click it, the squiggle model will be shown, and updated as you edit and save you file.
|
||||||
|
|
||||||
|
![](./images/extension-screenshot.png)
|
||||||
|
|
||||||
|
### Configuration (optional)
|
||||||
|
|
||||||
|
Some preview settings, e.g. whether to show the summary table or types of outputs, can be configurable on in the VS Code settings and persist between different preview sessions. The VS Code settings can be accessed with the shortcut `Ctrl+,` with `Ctrl+Shift+P` + searching "Open Settings", or by accessing a file like `$HOME/.config/Code/User/settings.json` in Linux (see [here](https://stackoverflow.com/questions/65908987/how-can-i-open-visual-studio-codes-settings-json-file)) for other operating systems.
|
||||||
|
|
||||||
|
![](./images/vs-code-settings.png)
|
||||||
|
|
||||||
Check out the full list of Squiggle settings in the main VS Code settings.
|
Check out the full list of Squiggle settings in the main VS Code settings.
|
||||||
|
|
||||||
# Build locally
|
## Build locally
|
||||||
|
|
||||||
We assume you ran `yarn` at the monorepo level for all dependencies.
|
We assume you ran `yarn` at the monorepo level for all dependencies.
|
||||||
|
|
||||||
|
|
BIN
packages/vscode-ext/images/extension-screenshot.png
Normal file
BIN
packages/vscode-ext/images/extension-screenshot.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 233 KiB |
BIN
packages/vscode-ext/images/vs-code-install.png
Normal file
BIN
packages/vscode-ext/images/vs-code-install.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 187 KiB |
BIN
packages/vscode-ext/images/vs-code-settings.png
Normal file
BIN
packages/vscode-ext/images/vs-code-settings.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 77 KiB |
Loading…
Reference in New Issue
Block a user