Skip to content

Commit c71396c

Browse files
authored
Guide > Tools > Positron (#1654)
* Add Positron notebook page * Add Positron Visual Editor * Fix file path * Add Positron landing * Add to Guide * Add screenshots * Re-organize * Fix explicit tool names * Use image preview instead of contextual help * Marketplace -> VSX * Use correct classes and images * Propogate change to later section * Show better Preview button in dark mode * More Positron specific screenshots + dark * More Positron specific screenshots * Add mention of toolbar Render on Save checkbox
1 parent 3a14407 commit c71396c

File tree

113 files changed

+577
-255
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

113 files changed

+577
-255
lines changed

_quarto.yml

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -194,15 +194,24 @@ website:
194194
- docs/visual-editor/content.qmd
195195
- docs/visual-editor/options.qmd
196196
- docs/visual-editor/markdown.qmd
197+
- section: "Positron"
198+
href: docs/tools/positron/index.qmd
199+
contents:
200+
- text: "Positron Basics"
201+
href: docs/tools/positron/index.qmd
202+
- text: "Visual Editor"
203+
href: docs/tools/positron/visual-editor.qmd
204+
- text: "Notebook Editor"
205+
href: docs/tools/positron/notebook.qmd
197206
- section: "VS Code"
198-
href: docs/tools/vscode.qmd
207+
href: docs/tools/vscode/index.qmd
199208
contents:
200209
- text: "VS Code Basics"
201-
href: docs/tools/vscode.qmd
210+
href: docs/tools/vscode/index.qmd
202211
- text: "Visual Editor"
203-
href: docs/visual-editor/vscode/index.qmd
212+
href: docs/tools/vscode/visual-editor.qmd
204213
- text: "Notebook Editor"
205-
href: docs/tools/vscode-notebook.qmd
214+
href: docs/tools/vscode/notebook.qmd
206215
- docs/tools/neovim.qmd
207216
- docs/tools/text-editors.qmd
208217
- section: "Documents"

docs/computations/_jupyter-execute.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ quarto render notebook.ipynb --execute
66

77
You can also specify this behavior within the notebook's YAML front matter:
88

9-
``` yaml
9+
```{.yaml filename="notebook.ipynb"}
1010
---
1111
title: "My Notebook"
1212
execute:

docs/computations/r.qmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ You can install the VS Code extension by searching for 'quarto' in the extension
117117
The VS Code extension includes a **Quarto: Preview** command that can be accessed via the Command Palette, the keyboard shortcut {{< kbd mac=Command-Shift-K win=Control-Shift-K linux=Control-Shift-K >}}, or a **Preview** button (![](/docs/tools/images/vscode-preview-icon.svg){fig-alt="Preview icon"}) in the editor.
118118
After rendering, a preview is displayed in a pane within VS Code alongside your document.
119119

120-
You can read more about using VS Code in [Tools: VS Code](/docs/tools/vscode.qmd).
120+
You can read more about using VS Code in [Tools: VS Code](/docs/tools/vscode/index.qmd).
121121

122122
## Emacs
123123

docs/dashboards/index.qmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Quarto Dashboards make it easy to create interactive dashboards using Python, R,
2626

2727
- Flexible and easy to specify row and column-based [Layouts](layout.qmd). Components are intelligently re-sized to fill the browser and adapted for display on mobile devices.
2828

29-
- Author using any notebook editor ([JupyterLab](/docs/tools/jupyter-lab.qmd), etc.) or in plain text markdown with any text editor ([VS Code](/docs/tools/vscode.qmd), [RStudio](/docs/tools/rstudio.qmd), [Neovim](/docs/tools/neovim.qmd), etc.)
29+
- Author using any notebook editor ([JupyterLab](/docs/tools/jupyter-lab.qmd), etc.) or in plain text markdown with any text editor ([VS Code](/docs/tools/vscode/index.qmd), [RStudio](/docs/tools/rstudio.qmd), [Neovim](/docs/tools/neovim.qmd), etc.)
3030

3131
- Dashboards can be deployed as static web pages (no special server required) or you can optionally integrate a backend [Shiny Server](/docs/dashboards/interactivity/shiny-python/index.qmd) for enhanced interactivity.
3232

docs/get-started/authoring/vscode.qmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,4 @@ editor_options:
1212
{{< include _text-editor.md >}}
1313

1414

15-
Additionally, if you are interested in seeing how to use Quarto from within `.ipynb` notebooks, check out the documentation on using the VS Code [Notebook Editor](/docs/tools/vscode.qmd#notebook-editor) with Quarto.
15+
Additionally, if you are interested in seeing how to use Quarto from within `.ipynb` notebooks, check out the documentation on using the VS Code [Notebook Editor](/docs/tools/vscode/notebook.qmd) with Quarto.

docs/get-started/hello/vscode.qmd

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Before getting started, you should install the [Quarto VS Code Extension](https:
2323
You can install the Quarto extension from within the **Extensions** tab in VS Code, from the [Extension Marketplace](https://marketplace.visualstudio.com/items?itemName=quarto.quarto), the [Open VSX Registry](https://open-vsx.org/extension/quarto/quarto) or directly from a [VISX extension file](https://github.com/quarto-dev/quarto-vscode#visx-install).
2424

2525
::: callout-note
26-
This tutorial focuses on editing plain text Quarto `.qmd` files in VS Code. Depending on your preferences and the task at hand there are two other editing modes available for Quarto documents: the [Visual Editor](/docs/visual-editor/vscode/index.qmd) and the [Notebook Editor](/docs/tools/vscode-notebook.qmd). For the purposes of learning we recommend you work through this tutorial using the VS Code text editor, then after you've mastered the basics explore using the other editing modes.
26+
This tutorial focuses on editing plain text Quarto `.qmd` files in VS Code. Depending on your preferences and the task at hand there are two other editing modes available for Quarto documents: the [Visual Editor](/docs/tools/vscode/visual-editor.qmd) and the [Notebook Editor](/docs/tools/vscode/notebook.qmd). For the purposes of learning we recommend you work through this tutorial using the VS Code text editor, then after you've mastered the basics explore using the other editing modes.
2727
:::
2828

2929
### Basic Workflow
@@ -137,7 +137,7 @@ This is the basic workflow for authoring with Quarto.
137137

138138
You do not need to save the file before rendering (as this happens automatically when you render).
139139
If you prefer, you can configure the Quarto extension to render whenever you save a document.
140-
See the documentation on [Render on Save](/docs/tools/vscode.qmd#render-on-save) for additional details.
140+
See the documentation on [Render on Save](/docs/tools/vscode/index.qmd#render-on-save) for additional details.
141141

142142
### Running Cells
143143

@@ -239,6 +239,6 @@ If you prefer to use an external browser for preview (or have no preview trigger
239239

240240
Additionally, you may wish to learn about the other editing modes for Quarto documents available within VS Code:
241241

242-
- The [Visual Editor](/docs/visual-editor/vscode/index.qmd) for WYSIWYG editing of `.qmd` documents.
242+
- The [Visual Editor](/docs/tools/vscode/visual-editor.qmd) for WYSIWYG editing of `.qmd` documents.
243243

244-
- The [Notebook Editor](/docs/tools/vscode-notebook.qmd) for editing `.ipynb` notebooks.
244+
- The [Notebook Editor](/docs/tools/vscode/notebook.qmd) for editing `.ipynb` notebooks.

docs/guide/guide.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,9 @@
4343
- text: RStudio IDE
4444
href: ../tools/rstudio.qmd
4545
- text: VS Code
46-
href: ../tools/vscode.qmd
46+
href: ../tools/vscode/index.qmd
47+
- text: Positron
48+
href: ../tools/positron/index.qmd
4749
- text: Neovim
4850
href: ../tools/neovim.qmd
4951
- text: Text Editors

docs/manuscripts/authoring/_overview.qmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ The syntax you'll learn will apply regardless of the tool you are using to edit
2323

2424
## Do you mostly use `.ipynb`?
2525

26-
As a VS Code user, we recommend writing your article in a `.qmd` file. However, if you currently use VS Code primarily to work with `.ipynb` files, you may find the Jupyter Lab tutorial more applicable. Install the [Quarto extension for Jupyter Lab](#install-the-quarto-vs-code-extension), then pick up the Jupyter Lab tutorial at [Clone the Template Repository](jupyterlab.qmd#clone-repo). You might also like read about using [Quarto with VS Code's Notebook Editor](/docs/tools/vscode-notebook.qmd).
26+
As a VS Code user, we recommend writing your article in a `.qmd` file. However, if you currently use VS Code primarily to work with `.ipynb` files, you may find the Jupyter Lab tutorial more applicable. Install the [Quarto extension for Jupyter Lab](#install-the-quarto-vs-code-extension), then pick up the Jupyter Lab tutorial at [Clone the Template Repository](jupyterlab.qmd#clone-repo). You might also like read about using [Quarto with VS Code's Notebook Editor](/docs/tools/vscode/notebook.qmd).
2727
:::
2828

2929
:::

docs/manuscripts/authoring/_visual-editor.qmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ To toggle between source and visual editor modes, use the Editor menu and select
2929

3030
![](images/source-visual-menu-vscode.png){fig-alt="Screenshot of the Editor menu in VS Code. The 'Edit in Visual Mode' item in the '...' menu is highlighted."}
3131

32-
There are other ways to switch modes, read about them, and other features of the visual editor at [Visual Editing in VS Code](/docs/visual-editor/vscode/index.qmd).
32+
There are other ways to switch modes, read about them, and other features of the visual editor at [Visual Editing in VS Code](/docs/tools/vscode/visual-editor.qmd).
3333
:::
3434

3535
You can switch between the source and visual editor at any time - the location of your cursor and undo/redo history is preserved.

docs/output-formats/_ssg-workflow.qmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ quarto preview
2121

2222
This will automatically run `{{< meta ssg-preview >}}` on your behalf to bring up a local preview server. In addition, it will monitor the filesystem for changes to `.qmd` and `.ipynb` inputs and automatically re-render them to {{< meta ssg-name >}} compatible `.md` files when they change.
2323

24-
Note that this also works for the integrated Render/Preview command within the [Quarto VS Code Extension](/docs/tools/vscode.qmd).
24+
Note that this also works for the integrated Render/Preview command within the [Quarto VS Code Extension](/docs/tools/vscode/index.qmd).
2525

2626
### Rendering
2727

0 commit comments

Comments
 (0)