diff --git a/_quarto.yml b/_quarto.yml index 5cfdd15409..bff4b8673f 100644 --- a/_quarto.yml +++ b/_quarto.yml @@ -691,6 +691,8 @@ format: filters: - filters/tools-tabset.lua - filters/color-box.lua + - at: post-quarto + path: filters/include-dark.lua freeze: true diff --git a/docs/authoring/diagrams.qmd b/docs/authoring/diagrams.qmd index ebefa23503..712007803d 100644 --- a/docs/authoring/diagrams.qmd +++ b/docs/authoring/diagrams.qmd @@ -94,12 +94,10 @@ There are a variety of tools available to improve your productivity authoring di 3) [RStudio](https://www.rstudio.com/products/rstudio/download/) includes support for editing and previewing `.mmd` and `.dot` files (with help from the [DiagrammeR](https://rich-iannone.github.io/DiagrammeR/) package). -4) The Quarto [VS Code Extension](https://marketplace.visualstudio.com/items?itemName=quarto.quarto) supports live preview of diagrams embedded in `.qmd` files and in `.mmd` and `.dot` files: +4) The Quarto Extension for VS Code and Positron (available on both [OpenVSX](https://open-vsx.org/extension/quarto/quarto) and [Microsoft's marketplace](https://marketplace.visualstudio.com/items?itemName=quarto.quarto)) supports live preview of diagrams embedded in `.qmd` files and in `.mmd` and `.dot` files: ![](images/vscode-graphviz.gif){.border fig-alt="A Quarto document being edited in Visual Studio Code, with a live preview of the currenly edited diagram shown in a pane to the right"} - Note that you should be sure to have installed the [very latest](https://marketplace.visualstudio.com/items?itemName=quarto.quarto) version of the Quarto VS Code extension to try this out. - ## Cross-References Diagrams can be treated as figures the same way that images and plot output are. For example, if we added the following figure options to the diagram above: diff --git a/docs/books/book-basics.qmd b/docs/books/book-basics.qmd index 8977642c8c..d3e90ad388 100644 --- a/docs/books/book-basics.qmd +++ b/docs/books/book-basics.qmd @@ -34,6 +34,26 @@ Follow the Quick Start for your tool of choice to get a simple book up and runni ::: {.panel-tabset group="tools-tabset"} +### Positron + +To create a new book project within Positron, execute the **Quarto: Create Project** command from the command-palette: + +![](/docs/websites/images/positron-create-project-command.png){.include-dark .border} + +Then, select **Book Project**: + +![](images/positron-create-project-book.png){.include-dark .border} + +You'll be prompted to select a parent directory to create the project within. Then, you'll be asked to name the directory for your book project: + +![](/docs/websites/images/positron-create-project-directory.png){.include-dark .border} + +The new book project will be created and opened within Positron. Click the **Preview** button (![](/docs/tools/images/vscode-preview-icon.svg){.light-content fig-alt="Preview icon"}![](/docs/tools/images/vscode-preview-icon-white.svg){.dark-content fig-alt="Preview icon"}) to preview the book: + +![](images/positron-create-project-render-book.png){.include-dark .border} + +The preview will show to the right of the source file. As you re-render `index.qmd` or render other files like `intro.qmd`, the preview is automatically updated. + ### VS Code To create a new book project within VS Code, execute the **Quarto: Create Project** command from the command-palette: @@ -48,7 +68,7 @@ You'll be prompted to select a parent directory to create the project within. Th ![](/docs/websites/images/vscode-create-project-directory.png){.border} -The new book project will be created and opened within VS Code. Click the **Preview** button (![](/docs/tools/images/vscode-preview-icon.svg){fig-alt="Preview icon"}) to preview the book: +The new book project will be created and opened within VS Code. Click the **Preview** button (![](/docs/tools/images/vscode-preview-icon.svg){.light-content fig-alt="Preview icon"}![](/docs/tools/images/vscode-preview-icon-white.svg){.dark-content fig-alt="Preview icon"}) to preview the book: ![](/docs/websites/images/vscode-create-project-render-book.png) diff --git a/docs/books/images/positron-create-project-book-dark.png b/docs/books/images/positron-create-project-book-dark.png new file mode 100644 index 0000000000..700026f7c6 Binary files /dev/null and b/docs/books/images/positron-create-project-book-dark.png differ diff --git a/docs/books/images/positron-create-project-book.png b/docs/books/images/positron-create-project-book.png new file mode 100644 index 0000000000..36b094ce40 Binary files /dev/null and b/docs/books/images/positron-create-project-book.png differ diff --git a/docs/books/images/positron-create-project-render-book-dark.png b/docs/books/images/positron-create-project-render-book-dark.png new file mode 100644 index 0000000000..f78077e296 Binary files /dev/null and b/docs/books/images/positron-create-project-render-book-dark.png differ diff --git a/docs/books/images/positron-create-project-render-book.png b/docs/books/images/positron-create-project-render-book.png new file mode 100644 index 0000000000..0ad231c5d6 Binary files /dev/null and b/docs/books/images/positron-create-project-render-book.png differ diff --git a/docs/computations/_jupyter-authoring-tools.md b/docs/computations/_jupyter-authoring-tools.md index 832d4fdab4..4f9bb7a33b 100644 --- a/docs/computations/_jupyter-authoring-tools.md +++ b/docs/computations/_jupyter-authoring-tools.md @@ -19,6 +19,10 @@ quarto preview document.ipynb In addition to including executable {{< meta jupyter-language >}} code chunks in a Quarto document, you can also embed cells from an external Jupyter Notebook (`.ipynb`). See [Embedding Jupyter Notebook Cells](/docs/authoring/notebook-embed.qmd) for more details. +## Positron + +{{< include _positron.md >}} + ## VS Code The [Quarto Extension](https://marketplace.visualstudio.com/items?itemName=quarto.quarto) for VS Code provides a variety of tools for working with `.qmd` files in VS Code. The extension integrates directly with the {{< meta vscode-extension >}} to provide the following {{< meta jupyter-language >}}-specific capabilities: diff --git a/docs/computations/_positron.md b/docs/computations/_positron.md new file mode 100644 index 0000000000..a335390855 --- /dev/null +++ b/docs/computations/_positron.md @@ -0,0 +1,12 @@ +The [Quarto Extension](https://open-vsx.org/extension/quarto/quarto) is bundled with Positron, and provides a variety of tools for working with `.qmd` files. The extension integrates directly with {{< meta positron-extension>}} to provide code completion, cell execution and side-by-side preview of Quarto documents. + +![]({{< meta positron-screenshot >}}){.include-dark .border fig-alt="Screen shot of qmd file open in Positron with source markdown shown in Editor pane and a rendered document shown in the Viewer Pane."} + +The 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){.light-content fig-alt="Preview icon"}![](/docs/tools/images/vscode-preview-icon-white.svg){.dark-content fig-alt="Preview icon"}) in the editor toolbar. +After rendering, a preview is displayed in the Viewer pane within Positron. + +You can read more about using Positron in [Tools: Positron](/docs/tools/positron/index.qmd). + +::: {.content-visible unless-meta="is_r"} +You can also use the Positron notebook editor to create `.ipynb` notebooks that you will render with Quarto. The [Jupyter Lab](#jupyter-lab) section discusses using notebooks with Quarto in the context of Jupyter Lab, but the same concepts apply to Positron. +::: \ No newline at end of file diff --git a/docs/computations/images/positron-hello-julia-dark.png b/docs/computations/images/positron-hello-julia-dark.png new file mode 100644 index 0000000000..a80d7dd777 Binary files /dev/null and b/docs/computations/images/positron-hello-julia-dark.png differ diff --git a/docs/computations/images/positron-hello-julia.png b/docs/computations/images/positron-hello-julia.png new file mode 100644 index 0000000000..17f53a2db4 Binary files /dev/null and b/docs/computations/images/positron-hello-julia.png differ diff --git a/docs/computations/inline-code.qmd b/docs/computations/inline-code.qmd index a787988965..9ed8b7d7da 100644 --- a/docs/computations/inline-code.qmd +++ b/docs/computations/inline-code.qmd @@ -72,7 +72,7 @@ If you need to generate a dynamic caption, instead of using the `fig-cap` or `tb ## Usage in Notebooks -Inline expressions are always evaluated when rendering and previewing `.qmd` files. However, for notebooks you need to execute the notebook with Quarto to evaluate inline expressions (i.e. they won't be evaluated within the JupyterLab, VS Code, or PyCharm notebook editor). +Inline expressions are always evaluated when rendering and previewing `.qmd` files. However, for notebooks you need to execute the notebook with Quarto to evaluate inline expressions (i.e. they won't be evaluated within the JupyterLab, Positron, VS Code, or PyCharm notebook editor). You can work in your favorite notebook front-end without Quarto execution, then once you are ready to publish execute the notebook during rendering as follows: diff --git a/docs/computations/julia.qmd b/docs/computations/julia.qmd index 8d7e469347..854b17a2bf 100644 --- a/docs/computations/julia.qmd +++ b/docs/computations/julia.qmd @@ -1,5 +1,7 @@ --- title: "Using Julia" +positron-extension: "the [Julia Extension](https://www.julia-vscode.org/docs)" +positron-screenshot: "images/positron-hello-julia.png" jupyter-language: "Julia" jupyter-screenshot: "![](images/julia-jupyter.png){.border fig-alt='Side-by-side preview of notebook on the left and live preview in the browser on the right.'}" vscode-extension: "[Julia Extension](https://www.julia-vscode.org/docs)" diff --git a/docs/computations/python.qmd b/docs/computations/python.qmd index 8d066cccdd..76b55aa6a2 100644 --- a/docs/computations/python.qmd +++ b/docs/computations/python.qmd @@ -1,5 +1,7 @@ --- title: "Using Python" +positron-extension: "Positron's native Python support" +positron-screenshot: "/docs/get-started/hello/images/positron-hello-python.png" jupyter-language: "Python" jupyter-screenshot: "![](/docs/get-started/hello/images/jupyter-basics.png){.border fig-alt='A Jupyter notebook titled Quarto Basics containing some text, a code cell, and the result of the code cell, which is a line plot on a polar axis.'}" vscode-extension: "[Python Extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python)" diff --git a/docs/computations/r.qmd b/docs/computations/r.qmd index a4efca77e0..4559b946e9 100644 --- a/docs/computations/r.qmd +++ b/docs/computations/r.qmd @@ -1,5 +1,8 @@ --- title: "Using R" +positron-extension: "Positron's native R support" +positron-screenshot: "/docs/get-started/hello/images/positron-hello-r.png" +is_r: true --- ## Overview @@ -101,6 +104,9 @@ Quarto will select a version of R by looking on the system `PATH`. In addition, {{< include ../tools/_rstudio.md >}} +## Positron + +{{< include _positron.md >}} ## VS Code @@ -114,7 +120,7 @@ The [Quarto Extension](https://marketplace.visualstudio.com/items?itemName=quart You can install the VS Code extension by searching for 'quarto' in the extensions panel or from the [extension marketplace](https://marketplace.visualstudio.com/items?itemName=quarto.quarto). -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. +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){.light-content fig-alt="Preview icon"}![](/docs/tools/images/vscode-preview-icon-white.svg){.dark-content fig-alt="Preview icon"}) in the editor. After rendering, a preview is displayed in a pane within VS Code alongside your document. You can read more about using VS Code in [Tools: VS Code](/docs/tools/vscode/index.qmd). diff --git a/docs/dashboards/index.qmd b/docs/dashboards/index.qmd index 52e8d3b023..28264aa19d 100644 --- a/docs/dashboards/index.qmd +++ b/docs/dashboards/index.qmd @@ -26,7 +26,7 @@ Quarto Dashboards make it easy to create interactive dashboards using Python, R, - 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. -- 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.) +- 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), [Positron](/docs/tools/positron/index.qmd), [RStudio](/docs/tools/rstudio.qmd), [Neovim](/docs/tools/neovim.qmd), etc.) - 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. diff --git a/docs/dashboards/interactivity/shiny-python/execution.qmd b/docs/dashboards/interactivity/shiny-python/execution.qmd index 83c41f4e24..1c1568804c 100644 --- a/docs/dashboards/interactivity/shiny-python/execution.qmd +++ b/docs/dashboards/interactivity/shiny-python/execution.qmd @@ -67,6 +67,6 @@ To learn more about Shiny for Python interactive documents see the following art - [Input Layout](/docs/dashboards/inputs.qmd) describes various ways to layout inputs (sidebars, input panels, attaching inputs directly to cards, etc.). -- [Running Dashboards](running.qmd) covers how to run interactive dashboards both within VS Code and at the command line, as well as how to deploy them to end users. +- [Running Dashboards](running.qmd) covers how to run interactive dashboards both within VS Code, Positron, and at the command line, as well as how to deploy them to end users. - [Shiny for Python](https://shiny.posit.co/py/) provides in-depth documentation on all of the available UI and ouput widgets, as well as conceptual discussions on how things work. diff --git a/docs/dashboards/interactivity/shiny-python/index.qmd b/docs/dashboards/interactivity/shiny-python/index.qmd index 21e14c0169..1b8de6d097 100644 --- a/docs/dashboards/interactivity/shiny-python/index.qmd +++ b/docs/dashboards/interactivity/shiny-python/index.qmd @@ -217,7 +217,7 @@ To learn more about Shiny for Python interactive documents see the following art [Input Layout](/docs/dashboards/inputs.qmd) describes various ways to layout Shiny inputs (sidebars, input panels, attaching inputs directly to cards, etc.) -[Running Dashboards](running.qmd) covers in more depth how to run Shiny dashboards both within VS Code and at the command line, as well as how to deploy them to end users. +[Running Dashboards](running.qmd) covers in more depth how to run Shiny dashboards both within VS Code, Positron, and at the command line, as well as how to deploy them to end users. [Execution Contexts](execution.qmd) goes in depth on when different code cells run (e.g. rendering vs. serving). diff --git a/docs/dashboards/interactivity/shiny-python/running.qmd b/docs/dashboards/interactivity/shiny-python/running.qmd index 98b33f4124..bed5abc3ce 100644 --- a/docs/dashboards/interactivity/shiny-python/running.qmd +++ b/docs/dashboards/interactivity/shiny-python/running.qmd @@ -7,7 +7,7 @@ lightbox: auto There are a number of ways to run Shiny for Python interactive documents: -1. Use the **Quarto: Preview** command within VS Code. +1. Use the **Quarto: Preview** command within VS Code or Positron. 2. Use the `quarto preview` command line interface with any editor. 3. Deploy them to a server for use by a wider audience. @@ -15,14 +15,12 @@ We'll cover all of these scenarios in depth here. {{< include _shiny-requirements.qmd >}} -## VS Code +## VS Code and Positron -The [Quarto VS Code Extension](https://marketplace.visualstudio.com/items?itemName=quarto.quarto) provides integrated support for previewing Shiny interactive documents (just use the **Quarto: Preview** command as you normally would with a static document): +The Quarto Extension for VS Code and Positron (available on both [OpenVSX](https://open-vsx.org/extension/quarto/quarto) and [Microsoft's marketplace](https://marketplace.visualstudio.com/items?itemName=quarto.quarto)) provides integrated support for previewing Shiny interactive documents (just use the **Quarto: Preview** command as you normally would with a static document): ![](images/preview-dashboard.png){.border fig-alt="Screenshot of VS Code with the file shiny.qmd open in the left pane. On the right is a pane labelled Quarto Preview showing the live dashboard."} -Note that you need the very latest version of the VS Code extension (v1.105.0 or greater) to preview Shiny interactive documents. - ## Command Line If you are using another notebook or text editor, you can also preview Shiny interactive documents from the command line via `quarto preview`. This works the same for notebooks (`.ipynb`) and plain text markdown (`.qmd`). For example: diff --git a/docs/extensions/filters.qmd b/docs/extensions/filters.qmd index de87e0d741..825d6508e3 100644 --- a/docs/extensions/filters.qmd +++ b/docs/extensions/filters.qmd @@ -52,7 +52,7 @@ You'll notice that one of the extensions (`spellcheck.lua`) has a file extension ### Quick Start -Here we'll describe how to create a simple filter extension. We'll use the `quarto create` command to do this. If you are using VS Code or RStudio you should execute `quarto create` within their respective integrated Terminal panes. +Here we'll describe how to create a simple filter extension. We'll use the `quarto create` command to do this. If you are using VS Code, Positron, or RStudio you should execute `quarto create` within their respective integrated Terminal panes. To get started, execute `quarto create extension filter` within the parent directory where you'd like the filter extension to be created: @@ -72,7 +72,7 @@ Creating extension at /Users/jjallaire/quarto/dev/fancy-header: - Created example.qmd ``` -If you are running within VS Code or RStudio a new window will open with the extension project. +If you are running within VS Code, Positron, or RStudio a new window will open with the extension project. Here's what the contents of the files in `_extensions/fancy-header/` look like: diff --git a/docs/extensions/formats.qmd b/docs/extensions/formats.qmd index 0e5eaa77c5..aa97090de7 100644 --- a/docs/extensions/formats.qmd +++ b/docs/extensions/formats.qmd @@ -46,7 +46,7 @@ quarto render document.qmd --to acm-html ## Quick Start -Here we'll describe how to create a simple HTML-based format extension. We'll use the `quarto create` command to do this. If you are using VS Code or RStudio you should execute `quarto create` within their respective integrated Terminal panes. +Here we'll describe how to create a simple HTML-based format extension. We'll use the `quarto create` command to do this. If you are using VS Code, Positron, or RStudio you should execute `quarto create` within their respective integrated Terminal panes. To get started, execute `quarto create extension format:html` within the parent directory where you'd like the format to be created: @@ -65,7 +65,7 @@ Creating extension at /Users/jjallaire/quarto/dev/lexdoc: - Created template.qmd ``` -If you are running within VS Code or RStudio a new window will open with the extension project. +If you are running within VS Code, Positron, or RStudio a new window will open with the extension project. ::: {.callout-note appearance="simple"} Note that this example creates a format that is derivative of the Quarto base `html` format. You can similarly create formats that are derivative of `pdf`, `docx`, and `revealjs` as follows: diff --git a/docs/extensions/lua.qmd b/docs/extensions/lua.qmd index 3d655ca7c1..df2fde5882 100644 --- a/docs/extensions/lua.qmd +++ b/docs/extensions/lua.qmd @@ -42,11 +42,11 @@ Some additional learning resources you might find useful include: Quarto preview, `quarto preview`, is aware of Lua source files within extensions, and will automatically reload the preview whenever a Lua source file changes. -This makes it very easy to incrementally develop and debug Lua code (especially when combined with the [native](#native-format) format a described below). Live reloading for Lua files will work no matter what source code editor you are using (VS Code, RStudio, Neovim, etc.). +This makes it very easy to incrementally develop and debug Lua code (especially when combined with the [native](#native-format) format a described below). Live reloading for Lua files will work no matter what source code editor you are using (Positron, VS Code, RStudio, Neovim, etc.). -### VS Code +### VS Code / Positron -While you can use any text editor along with `quarto preview` for developing Lua extensions, we strongly recommend that you consider using VS Code, as it provides a number of additional tools including: +While you can use any text editor along with `quarto preview` for developing Lua extensions, we strongly recommend that you consider using VS Code or Positron, as they provide a number of additional tools including: 1. Code completion and type checking. @@ -64,17 +64,17 @@ Diagnostics check for many common errors including failing to check for `nil`, u #### Installation -To get started with using VS Code for Lua extension development, install the following software: +To get started with using VS Code or Positron for Lua extension development, install the following software: 1. Install the latest version (v1.2 or greater) of [Quarto](/docs/download/index.qmd) -2. Install the latest version (v1.40.0 or greater) of the [Quarto VS Code Extension](https://marketplace.visualstudio.com/items?itemName=quarto.quarto). +2. Install the latest version (v1.40.0 or greater) of the Quarto Extension (available on both [OpenVSX](https://open-vsx.org/extension/quarto/quarto) and [Microsoft's marketplace](https://marketplace.visualstudio.com/items?itemName=quarto.quarto)) . -3. For Lua code intelligence, install the [Lua LSP VS Code Extension](https://marketplace.visualstudio.com/items?itemName=sumneko.lua). +3. For Lua code intelligence, install the Lua LSP Extension (available on both [OpenVSX](https://open-vsx.org/extension/sumneko/lua) and [Microsoft's marketplace](https://marketplace.visualstudio.com/items?itemName=sumneko.lua)). Once you've installed these components you should see the features described above appear automatically in your Quarto workspaces that include Lua code. -There are many options available for configuring Lua completion and diagnostics. It's also possible to provide type information for your own functions. See the section on [Lua in VS Code](#lua-in-vs-code) below for details. +There are many options available for configuring Lua completion and diagnostics. It's also possible to provide type information for your own functions. See the section on [Lua in Positron and VS Code](#lua-in-vs-code) below for details. ## Diagnostic Logging @@ -247,7 +247,7 @@ end ::: ::: -## Lua in VS Code {#lua-in-vs-code} +## Lua in Positron and VS Code {#lua-in-vs-code} ### Type Hints @@ -268,7 +268,7 @@ You can learn more about all of the available type annotations in the [Annotatio ### Settings -The [Lua Language Server](https://marketplace.visualstudio.com/items?itemName=sumneko.lua) extension includes a wide variety of options to customize its behavior (e.g. what diagnostics to show, which completions to offer, etc.). +The [Lua Language Server](https://open-vsx.org/extension/sumneko/lua) extension includes a wide variety of options to customize its behavior (e.g. what diagnostics to show, which completions to offer, etc.). All of the available options are documented in the [Settings Reference](https://luals.github.io/wiki/settings/) for the Lua Language Server. @@ -295,4 +295,4 @@ You can change any of the settings within this file save for the `Lua.workspace. If you prefer to manage this file manually, simply remove the `Generator` key and Quarto will no longer update the `Lua.workspace.library` and `Lua.runtime.plugin` settings automatically. -You can also globally disable the automatic creation of `.luarc.json` using the **Quarto \> Lua: Provide Types** VS Code setting. +You can also globally disable the automatic creation of `.luarc.json` using the **Quarto \> Lua: Provide Types** setting. diff --git a/docs/extensions/metadata.qmd b/docs/extensions/metadata.qmd index 115e191a0b..249df0d6e6 100644 --- a/docs/extensions/metadata.qmd +++ b/docs/extensions/metadata.qmd @@ -12,7 +12,7 @@ Currently, metadata extensions only merge project-level metadata. This limitatio ### Quick Start -Here we'll describe how to create a simple metadata extension. We'll use the `quarto create` command to do this. If you are using VS Code or RStudio you should execute `quarto create` within their respective integrated Terminal panes. +Here we'll describe how to create a simple metadata extension. We'll use the `quarto create` command to do this. If you are using VS Code, Positron, or RStudio you should execute `quarto create` within their respective integrated Terminal panes. To get started, execute `quarto create extension metadata` within the parent directory where you'd like the filter extension to be created: @@ -35,7 +35,7 @@ Creating extension at /Users/cscheid/Desktop/my-prerender-scripts: (don't open) ``` -If you are running within VS Code or RStudio a new window will open with the extension project. +If you are running within VS Code, Positron, or RStudio a new window will open with the extension project. ## Contents of Metadata Extensions diff --git a/docs/extensions/project-types.qmd b/docs/extensions/project-types.qmd index 2bdac7a456..3878b88029 100644 --- a/docs/extensions/project-types.qmd +++ b/docs/extensions/project-types.qmd @@ -33,7 +33,7 @@ Note that it is possible to bundle and distribute project type extensions as sim ## Development Tools -If you are using custom project types within VS Code or RStudio, only the very latest versions of these tools handle custom project types correctly: +If you are using custom project types within VS Code, Positron, or RStudio, only the very latest versions of these tools handle custom project types correctly: - For the Quarto VS Code Extension, use [version 1.45](https://marketplace.visualstudio.com/items?itemName=quarto.quarto) or greater. diff --git a/docs/extensions/revealjs.qmd b/docs/extensions/revealjs.qmd index 9361d4d653..58cc97b6d4 100644 --- a/docs/extensions/revealjs.qmd +++ b/docs/extensions/revealjs.qmd @@ -19,7 +19,7 @@ Here are some examples of Revealjs plugins packaged as Quarto extensions: ## Quick Start -Here we'll describe how to create a simple Revealjs plugin extension. We'll use the `quarto create` command to do this. If you are using VS Code or RStudio you should execute `quarto create` within their respective integrated Terminal panes. +Here we'll describe how to create a simple Revealjs plugin extension. We'll use the `quarto create` command to do this. If you are using VS Code, Positron, or RStudio you should execute `quarto create` within their respective integrated Terminal panes. To get started, execute `quarto create extension revealjs-plugin` within the parent directory where you'd like the plugin extension to be created: @@ -40,7 +40,7 @@ Creating extension at /Users/jjallaire/quarto/dev/shuffler: - Created example.qmd ``` -If you are running within VS Code or RStudio a new window will open with the extension project. +If you are running within VS Code, Positron, or RStudio a new window will open with the extension project. Here's what the contents of the files in `_extensions/shuffler/` look like: diff --git a/docs/extensions/shortcodes.qmd b/docs/extensions/shortcodes.qmd index b84213e5a0..a3b51f51d9 100644 --- a/docs/extensions/shortcodes.qmd +++ b/docs/extensions/shortcodes.qmd @@ -10,7 +10,7 @@ This article describes how to create your own shortcodes. ## Quick Start -Here we'll describe how to create a simple shortcode extension. We'll use the `quarto create` command to do this. If you are using VS Code or RStudio, you should execute `quarto create` within their respective integrated terminal panes. +Here we'll describe how to create a simple shortcode extension. We'll use the `quarto create` command to do this. If you are using VS Code, Positron, or RStudio, you should execute `quarto create` within their respective integrated terminal panes. To get started, execute `quarto create extension shortcode` within the parent directory where you'd like the shortcode extension to be created: @@ -30,7 +30,7 @@ Creating extension at /Users/jjallaire/extensions/shorty/shorty: - Created example.qmd ``` -If you are running within VS Code or RStudio, a new window will open with the extension project. +If you are running within VS Code, Positron, or RStudio, a new window will open with the extension project. Here's what the contents of the files in `_extensions/shorty/` look like: diff --git a/docs/get-started/computations/positron.qmd b/docs/get-started/computations/positron.qmd index 14c58ca5e3..424ae929fa 100644 --- a/docs/get-started/computations/positron.qmd +++ b/docs/get-started/computations/positron.qmd @@ -3,8 +3,6 @@ title: "Tutorial: Computations" css: ../positron.css tool: name: positron -filters: - - ../include-dark.lua --- {{< include ../_tool-chooser.md >}} diff --git a/docs/get-started/hello/positron.qmd b/docs/get-started/hello/positron.qmd index c45f128a24..7ab082ac4d 100644 --- a/docs/get-started/hello/positron.qmd +++ b/docs/get-started/hello/positron.qmd @@ -7,8 +7,6 @@ editor_options: canonical: true tool: name: positron -filters: - - ../include-dark.lua --- {{< include ../_tool-chooser.md >}} diff --git a/docs/journals/formats.qmd b/docs/journals/formats.qmd index 85199a6369..d78e73e65c 100644 --- a/docs/journals/formats.qmd +++ b/docs/journals/formats.qmd @@ -49,7 +49,7 @@ quarto render document.qmd --to acm-pdf ## Quick Start -Here we'll describe how to create a simple Journal article format extension. We'll use the `quarto create` command to do this. If you are using VS Code or RStudio you should execute `quarto create` within their respective integrated Terminal panes. +Here we'll describe how to create a simple Journal article format extension. We'll use the `quarto create` command to do this. If you are using VS Code, Positron, or RStudio you should execute `quarto create` within their respective integrated Terminal panes. To get started, execute `quarto create extension journal` within the parent directory where you'd like the format to be created: @@ -71,7 +71,7 @@ Creating extension at /Users/jjallaire/quarto/dev/aps: - Created bibliography.bib ``` -If you are running within VS Code or RStudio a new window will open with the extension project. +If you are running within VS Code, Positron, or RStudio a new window will open with the extension project. Here's what the contents of the files in `_extensions/aps/` look like: diff --git a/docs/output-formats/_ssg-workflow.qmd b/docs/output-formats/_ssg-workflow.qmd index 6d6f21711a..f04189be47 100644 --- a/docs/output-formats/_ssg-workflow.qmd +++ b/docs/output-formats/_ssg-workflow.qmd @@ -21,7 +21,7 @@ quarto preview 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. -Note that this also works for the integrated Render/Preview command within the [Quarto VS Code Extension](/docs/tools/vscode/index.qmd). +Note that this also works for the integrated Preview command within the Quarto VS Code Extension in [VS Code](/docs/tools/vscode/index.qmd) or [Positron](/docs/tools/positron/index.qmd). ### Rendering diff --git a/docs/output-formats/html-multi-format.qmd b/docs/output-formats/html-multi-format.qmd index 5e8be3bf4e..ff69a2fbd8 100644 --- a/docs/output-formats/html-multi-format.qmd +++ b/docs/output-formats/html-multi-format.qmd @@ -35,7 +35,7 @@ Links to additional formats are displayed by default, but you can control whethe ::: callout-note ## Rendering All Formats in Standalone HTML Documents -The Render buttons in RStudio and VS Code will not automatically render all formats if the document isn't part of a Quarto website. To render all formats use `quarto render` on the command line: +The Render button in RStudio, and the Preview button in Positron and VS Code, will not automatically render all formats if the document isn't part of a Quarto website. To render all formats use `quarto render` on the command line: ``` {.bash filename="Terminal"} quarto render multi-format.qmd diff --git a/docs/projects/profiles.qmd b/docs/projects/profiles.qmd index 393a5ae7bf..1abd619729 100644 --- a/docs/projects/profiles.qmd +++ b/docs/projects/profiles.qmd @@ -195,7 +195,7 @@ By specifying a `group` we indicate that one of the profiles must be defined, an When authoring a Quarto project that uses profiles you might want to change which profile(s) are rendered by default to try out different variations of the project. -While you could certainly do this by defining environment variables in your shell, this isn't particularly convenient when using the integrated render and preview functionality in VS Code and RStudio. +While you could certainly do this by defining environment variables in your shell, this isn't particularly convenient when using the integrated render and preview functionality in Positron, VS Code, and RStudio. To define a default profile that is used when an explicit `QUARTO_PROFILE` or `--profile` CLI argument is not present, add a `default` option to the `profile` key. For example, here we indicate that `development` should be the active profile if not otherwise specified: diff --git a/docs/projects/virtual-environments.qmd b/docs/projects/virtual-environments.qmd index 9b0562a78b..76c7f6db22 100644 --- a/docs/projects/virtual-environments.qmd +++ b/docs/projects/virtual-environments.qmd @@ -15,7 +15,7 @@ There are several popular flavors of virtual environment, we will cover the foll Below we'll provide some example workflows for using these tools with Quarto. In these examples we'll assume that you are already within a project directory that contains Quarto documents (so the virtual environment will be created as a sub-directory of the project). -We'll also cover using virtual environments with [JupyterLab](#jupyterlab), [RStudio](#rstudio), and [VS Code](#vs-code). +We'll also cover using virtual environments with [JupyterLab](#jupyterlab), [RStudio](#rstudio), [Positron](#positron) and [VS Code](#vs-code). Quarto can also detect the virtual environments discussed on this page to configure your project for Binder. Read more at [Using Quarto with Binder](binder.qmd). @@ -308,6 +308,21 @@ More about Python Version Configuration for **reticulate** at