Skip to content

Commit 17b0553

Browse files
committed
Add screenshots
1 parent 934079d commit 17b0553

File tree

10 files changed

+19
-13
lines changed

10 files changed

+19
-13
lines changed

docs/tools/_code-oss-editors.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,11 @@ We'll cover the source code editor below, however you might also want to consult
1515
The Quarto VS Code extension includes commands and keyboard shortcuts for rendering Quarto documents (both standalone and within websites or books). After rendering, `quarto preview` is used behind the scenes to provide a [preview pane]{
1616
.content-hidden unless-meta="tool.is_vscode"}[preview in the Viewer Pane]{.content-hidden unless-meta="tool.is_positron"} within {{< meta tool.name >}} alongside your document:
1717

18-
![]({{< meta tool.image-prefix >}}-render.png){.border fig-alt='Two windows arranged side by side. The window on the left is a qmd file opened in {{< meta tool.name >}}. The contents of this document are the same as the first part of the Getting Started: Welcome section of this website. The contents of this document are rendered by Quarto in the window on the right.'}
18+
![](images/{{< meta tool.prefix >}}-render.png){.border fig-alt='Two windows arranged side by side. The window on the left is a qmd file opened in {{< meta tool.name >}}. The contents of this document are the same as the first part of the Getting Started: Welcome section of this website. The contents of this document are rendered by Quarto in the window on the right.'}
1919

2020
To render and preview, execute the **Quarto: Preview** command. You can alternatively use the <kbd>Ctrl+Shift+K</kbd> keyboard shortcut, or the **Preview** button (![](images/vscode-preview-icon.svg){fig-alt="Preview icon"}) at the top right of the editor:
2121

22-
![]({{< meta tool.image-prefix >}}-preview-button.png){.border fig-alt='The top of the {{< meta tool.name >}} editor. The right side of the editor tab area includes a Preview button.'}
22+
![](images/{{< meta tool.prefix >}}-preview-button.png){.border fig-alt='The top of the {{< meta tool.name >}} editor. The right side of the editor tab area includes a Preview button.'}
2323

2424
::: {.callout-note appearance="simple"}
2525
Note that on the Mac you should use `Cmd` rather than `Ctrl` as the prefix for all Quarto keyboard shortcuts.
@@ -74,13 +74,13 @@ If you prefer to use an external browser for preview (or have no preview trigger
7474
7575
There are a variety of tools that make it easier to edit and execute code cells. Editing tools include syntax highlighting, code folding, code completion, and signature tips:
7676
77-
![](images/vscode-code-cell.png){.border fig-alt='A Quarto document in {{< meta tool.name >}} with a python code cell. There is a code completion helper active in the python cell.'}
77+
![](images/{{< meta tool.prefix >}}-code-cell.png){.border fig-alt='A Quarto document in {{< meta tool.name >}} with a python code cell. There is a code completion helper active in the python cell.'}
7878
7979
For Python, R, and Julia cells, commands are available to execute the current cell, previous cells, or the currently selected line(s).
8080
[Cell output is shown side by side in the Jupyter interactive console:]{.content-hidden unless-meta="tool.is_vscode"}
8181
[R and Python cells are executed in the appropriate Console, and output is shown in the pane:]{.content-hidden unless-meta="tool.is_vscode"}
8282
83-
![](images/vscode-execute-cell.png){.border fig-alt='{{< meta tool.name >}} with two panes open, vscode.qmd source code on the right, and the interactive output of that code shown in a second pane on the left.'}
83+
![](images/{{< meta tool.prefix >}}-execute-cell.png){.border fig-alt='{{< meta tool.name >}} with two panes open, vscode.qmd source code on the right, and the interactive output of that code shown in a second pane on the left.'}
8484
8585
Here are all of the commands and keyboard shortcuts available for executing cells:
8686
@@ -140,7 +140,13 @@ Execute the **Quarto: Show Assist Panel** command to show a panel in the sidebar
140140

141141
For example, below help on the matplotlib `plot()` function is shown automatically when the cursor is located on the function:
142142

143+
::: {.content-hidden unless-meta="tool.is_vscode"}
143144
![](/docs/computations/images/python-vscode.png){.border fig-alt='Screenshot of {{< meta tool.name >}} editor with three vertical sections. The leftmost includes the file explorer, and quarto help. The second pane is the source code for a quarto file with python code. The third is interactive with Python running and output of the code cells shown.'}
145+
:::
146+
147+
::: {.content-hidden unless-meta="tool.is_positron"}
148+
![](images/positron-python.png){.border .preview-image fig-alt="Screen shot of Positron editor with three vertical sections. The leftmost includes the file explorer, and quarto help. The second pane is the source code for a quarto file with python code, and the active Python Console. The third shows the Environment and Plots for the active console populated with the output of the code cells."}
149+
:::
144150

145151
## Live Preview
146152

@@ -194,6 +200,6 @@ Use the **Go to File** command <kbd>Ctrl+P</kbd> to navigate to other files and
194200

195201
Besides the traditional source editor described above, you can also use one of the following other editors depending on your preferences and task at hand:
196202

197-
1. The [Visual Editor](/docs/visual-editor/vscode/index.qmd) for WYSIWYG editing of `.qmd` documents.
203+
1. The [Visual Editor](/docs/visual-editor/{{< meta tool.prefix >}}/index.qmd) for WYSIWYG editing of `.qmd` documents.
198204

199-
2. The [Notebook Editor](/docs/tools/vscode-notebook.qmd) for editing `.ipynb` notebooks.
205+
2. The [Notebook Editor](/docs/tools/{{< meta tool.prefix >}}-notebook.qmd) for editing `.ipynb` notebooks.

docs/tools/_code-oss-notebook.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ In addition to editing Quarto documents as plain-text `.qmd` files, you can also
44

55
The basic workflow for editing notebooks for use with Quarto is identical to the workflow for `.qmd` files. Edit the file and then execute the **Quarto: Preview** command (you can alternatively use the <kbd>Ctrl+Shift+K</kbd> keyboard shortcut). You'll see a preview of the published page side by side with the notebook:
66

7-
![]({{< meta tool.image-prefix >}}-notebook.png){.border}
7+
![](images/{{< meta tool.prefix >}}-notebook.png){.border}
88

99
After you've done an initial **Quarto: Preview**, the preview will automatically update every time you save the notebook.
1010

201 KB
Loading
307 KB
Loading

docs/tools/positron-notebook.qmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Positron Notebook Editor
33
tool:
44
name: Positron
5-
image-prefix: images/positron
5+
prefix: images/positron
66
---
77

88
{{< include _code-oss-notebook.md >}}

docs/tools/positron.qmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Positron
33
tool:
44
name: Positron
55
is_positron: true
6-
image-prefix: images/positron
6+
prefix: positron
77
---
88

99
## Overview

docs/tools/vscode-notebook.qmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: VS Code Notebook Editor
33
tool:
44
name: VS Code
5-
image-prefix: images/vscode
5+
prefix: vscode
66
---
77

88
{{< include _code-oss-notebook.md >}}

docs/tools/vscode.qmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: VS Code
33
tool:
44
name: VS Code
55
is_vscode: true
6-
image-prefix: images/vscode
6+
prefix: vscode
77
---
88

99
## Overview

docs/visual-editor/positron/index.qmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Visual Editing in Positron"
33
tool:
44
name: Positron
5-
image-prefix: images/positron
5+
prefix: positron
66
is_positron: true
77
---
88

docs/visual-editor/vscode/index.qmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Visual Editing in VS Code"
33
tool:
44
name: Visual Studio Code
5-
image-prefix: images/vscode
5+
prefix: vscode
66
is_vscode: true
77
---
88

0 commit comments

Comments
 (0)