Guide > Tools > Positron #1654
Guide > Tools > Positron #1654
Conversation
|
🚀 Deployed on https://deploy-preview-1654.quarto.org |
There was a problem hiding this comment.
This is looking so great! 🙌 Thank you so much for working on this.
I noted some places where I don't think the screenshots can be re-used between Positron and VS Code, because of changes we've made to the UI. I think the other thing to consider is how to link to OpenVSX for the Positron pages.
Let me know if you have questions on any of that!
|
|
||
| Positron bundles both the Quarto CLI and the VS Code Quarto extension so it comes ready to work with Quarto out-of-the-box. | ||
|
|
||
| The [Quarto VS Code Extension](https://marketplace.visualstudio.com/items?itemName=quarto.quarto) provides the support for Quarto in Positron, including: |
There was a problem hiding this comment.
In Positron, we can't use the MS marketplace, so I think it would be better to link to OpenVSX here:
https://open-vsx.org/extension/quarto/quarto
|
|
||
| The [Quarto VS Code Extension](https://marketplace.visualstudio.com/items?itemName=quarto.quarto) provides the support for Quarto in Positron, including: | ||
|
|
||
| - Integrated render and preview for Quarto documents. |
There was a problem hiding this comment.
| - Integrated render and preview for Quarto documents. | |
| - Integrated render and preview for Quarto documents |
| - Live preview for LaTeX math as well as Mermaid and Graphviz diagrams | ||
|
|
||
| The Quarto extension integrates directly with Positron's native R and Python features. | ||
| For example, here the Quarto extension runs a Python cell in the active Python Console and shows contextual help for Python functions. |
There was a problem hiding this comment.
Positron has an integrated help pane also, so it is a little awkward to be showing the Quarto help pane. What do you think about highlighting something else here?
|
|
||
| {.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."} | ||
|
|
||
| The Quarto extension also works well with other extensions bundled with Positron, like Jupyter extension, and those you might install separately, like the Julia extension. |
There was a problem hiding this comment.
| The Quarto extension also works well with other extensions bundled with Positron, like Jupyter extension, and those you might install separately, like the Julia extension. | |
| The Quarto extension works well with both other extensions bundled with Positron, like the Jupyter extension, as well as those you might install yourself separately, like the Julia extension. |
| @@ -51,11 +29,11 @@ Note that on the Mac you should use `Cmd` rather than `Ctrl` as the prefix for a | |||
|
|
|||
| The **Quarto: Preview** command renders the default format of the currently active document. If you want to preview a different format, use the **Quarto: Preview Format** command: | |||
|
|
|||
| {.border fig-alt="The top of the Visual Studio code editor. The editor title menu is expanded and the Preview Format command is available on the menu."} | |||
| {.border fig-alt='The top of the {{< meta tool.name >}} editor. The editor title menu is expanded and the Preview Format command is available on the menu.'} | |||
There was a problem hiding this comment.
This screenshot is very clearly not Positron. Is it possible to have two versions here?
|
|
||
| ## Code Snippets | ||
|
|
||
| Code snippets are templates that make it easier to enter repeating code patterns (e.g. code blocks, callouts, divs, etc.). Execute the **Insert Snippet** command within a Quarto document to insert a markdown snippet: | ||
|
|
||
| {.border fig-alt="Quarto document with dropdown 'Select a snippet' dropdown, the first item (bold - insert bold text) is selected."} | ||
| {.border fig-alt="Quarto document with dropdown 'Select a snippet' dropdown, the first item (bold - insert bold text) is selected."} |
There was a problem hiding this comment.
Can we have a Positron screenshot here?
| @@ -185,18 +188,18 @@ VSCode uses IntelliSense to suggest snippets or possible values for a specific f | |||
|
|
|||
| If you have a large document use the outline view for quick navigation between sections: | |||
|
|
|||
| {.border fig-alt="Quarto document with outline view shown in left-hand panel. The outline shows the section headers of the quarto documents."} | |||
| {.border fig-alt="Quarto document with outline view shown in left-hand panel. The outline shows the section headers of the quarto documents."} | |||
There was a problem hiding this comment.
Can we have a Positron screenshot here?
|
|
||
| ## Code Snippets | ||
|
|
||
| Code snippets are templates that make it easier to enter repeating code patterns (e.g. code blocks, callouts, divs, etc.). Execute the **Insert Snippet** command within a Quarto document to insert a markdown snippet: | ||
|
|
||
| {.border fig-alt="Quarto document with dropdown 'Select a snippet' dropdown, the first item (bold - insert bold text) is selected."} | ||
| {.border fig-alt="Quarto document with dropdown 'Select a snippet' dropdown, the first item (bold - insert bold text) is selected."} | ||
|
|
||
| ### IntelliSense |
There was a problem hiding this comment.
In this section, we should say "Positron" rather than "VSCode".
|
|
||
| You can also use the **Go to Symbol in Editor** command or keyboard shortcut <kbd>Ctrl+Shift+O</kbd> for type-ahead navigation of the current document's outline. | ||
|
|
||
| Use the **Go to File** command <kbd>Ctrl+P</kbd> to navigate to other files and the **Go to Symbol in Workspace** command <kbd>Ctrl+T</kbd> for type-ahead navigation to all headings in the workspace: | ||
|
|
||
| {.border fig-alt="Quarto document in VS Code with command palette open showing the files in the project with the entered term, 'margin'."} | ||
| {.border fig-alt='Quarto document in {{< meta tool.name >}} with command palette open showing the files in the project with the entered term, \'margin\'.'} |
There was a problem hiding this comment.
Can we have a Positron screenshot here?
| --- | ||
| title: "Visual Editing in VS Code" | ||
| --- | ||
|
|
||
| ## Overview | ||
|
|
||
| The [Quarto VS Code Extension](https://marketplace.visualstudio.com/items?itemName=quarto.quarto) includes a visual markdown editor that supports all of Quarto's markdown syntax including tables, citations, cross-references, footnotes, divs/spans, definition lists, attributes, raw HTML/TeX, and more: |
There was a problem hiding this comment.
For the Positron version of this page (or both!) we shouldn't link to the MS marketplace.
There was a problem hiding this comment.
I do think this page could use some updates to be more accurate for Positron. For example, you can't switch between source and visual mode from the editor menu but you can from the new bar.
The screenshots that show the tab bar should be updated, since we have made UI changes there; the screenshots of just the command palette are OK. 👍
A first pass at Guide > Tools > Positron by making minor changes to Guide > Tools > VS Code:
Guide > Tools > Positron > Positron Basics
VS code->Positron(except in "VS Code Quarto Extension")Guide > Tools > Positron > Notebook Editor:
VS code->PositronGuide > Tools > Positron > Visual Editor:
VS code->Positron(except in "VS Code Quarto Extension")Most content is included from:
tools/_code-oss-editors.mdtools/_code-oss-notebook.mdtools/_code-oss-visual-editor.md