Quarto Wizard

Overview

Quarto Wizard is a Visual Studio Code extension that helps you manage your Quarto projects.
It allows you to easily install Quarto extensions directly from the Quarto Extensions listing repository.
This extension provides a user-friendly interface to browse, select, and install Quarto extensions, enhancing your Quarto development experience.
Additionally, it offers a set of commands to create new Quarto documents that you can use for as a starting point for your bug reports, feature requests, or any other Quarto-related content. Finally, it provides an automatic Markdown linting feature to help you write better Markdown documents.

Requirements

• Check Internet Connection: Ensure you have an active internet connection before installing extensions.
• Check Quarto Installation: Verify that Quarto is installed and available in your system's PATH.

Commands

• Quarto Wizard: Install Extension(s): Opens the extension installer interface.
  • Browse Extensions: View a list of available Quarto extensions.

    

  • Install Extensions: Install selected Quarto extensions with a single click.
• Quarto Wizard: Use Template: Opens the template installer interface.
  • Browse Templates: View a list of available Quarto templates from Quarto Extensions.

    

  • Install Templates: Install selected Quarto template with a single click.
• Quarto Wizard: Clear Recently Installed Extensions: Clears the list of recently installed extensions.
• Quarto Wizard: Show Quarto Wizard Log Output: Displays the output log for the extension installer.
• Quarto Wizard: Quarto Reproducible Document: Creates a new Quarto document.
  • R
  • Python
  • Julia
• Quarto Wizard: Focus on Extensions Installed View: Opens the Quarto Wizard view to display and manage the Quarto extensions installed.

Usage

Quarto Wizard Explorer View

1. Open the Command Palette (Ctrl+Shift+P or Cmd+Shift+P on macOS).
2. Type Quarto Wizard: Focus on Extensions Installed View and select it.
   Or click on the Quarto Wizard icon in the Activity Bar.

   

Or click on the Quarto Wizard icon in the Activity Bar.

Quarto Wizard Explorer View in action:

explorer-view.mp4

Important

Quarto extensions can only be updated if installed by Quarto Wizard (i.e., if source: <owner>/<repository> is present in _extension.yml). You can manually add the source to the extension's _extension.yml file to enable updates.

Explorer/Editor Context Menu

• Right-click in the Explorer or Editor to access the following commands:
  • Install Extension(s).
  • Use Template.
  • Quarto Reproducible Document.
  • Show Quarto Wizard Log Output.
  • Clear Recently Installed Extensions.

Install Quarto Extensions

1. Open the Command Palette (Ctrl+Shift+P or Cmd+Shift+P on macOS).
2. Type Quarto Wizard: Install Extension(s) and select it.
3. Browse the list of available Quarto extensions.
4. Select the Quarto extension(s) you want to install.
5. Answer the prompts to confirm the installation.

Note

Quarto Wizard can only display available informations, i.e., if the author of an extension has not provided a description, license, and/or used tags for release versions, these fields will be populated with none.

Use Quarto Templates

1. Open the Command Palette (Ctrl+Shift+P or Cmd+Shift+P on macOS).
2. Type Quarto Wizard: Use Template and select it.
3. Browse the list of available Quarto templates.
4. Select the Quarto template you want to use.
5. Answer the prompts to confirm the installation.

Create a New Reproducible Document

1. Open the Command Palette (Ctrl+Shift+P or Cmd+Shift+P on macOS).
2. Type Quarto Wizard: Quarto Reproducible Document and select it.
3. Choose the template for the new Quarto document.

Show Quarto Wizard Output

1. Open the Command Palette (Ctrl+Shift+P or Cmd+Shift+P on macOS).
2. Type Quarto Wizard: Show Quarto Wizard Log Output and select it.
3. View the output log for the Quarto Wizard extension.
4. Use the output log to troubleshoot any issues.

Markdown Linting

The Quarto Wizard extension provides automatic Markdown linting to help you write better Markdown documents.
This is achieved by using the markdownlint extension.

In the context of Quarto, it's recommended to disable the following rule in your settings.json file:

{
  "markdownlint.config": {
    "first-line-h1": false, //MD041
    "single-h1": false // MD025
  }
}

See the markdownlint README for more information.

Custom Markdown Linting Rules

• QMD001 / blanks-around-fenced-divs: Ensure there are no blank lines around fenced divs delimiters.

  {
    "markdownlint.config": {
      "blanks-around-fenced-divs": true
    }
  }

Verifying Release Asset Build Provenance

To ensure the authenticity and integrity of the release asset, use GitHub CLI to verify its build provenance using GitHub CLI.

gh attestation verify quarto-wizard-<version>.vsix --repo mcanouil/quarto-wizard

Development

1. Clone the repository:

   git clone https://github.com/mcanouil/quarto-wizard

2. Open the project in Visual Studio Code.

3. Install the dependencies:

   npm install

4. Launch the extension:

   • Press F5 to open a new Visual Studio Code window with the extension loaded.

Contributing

Contributions are welcome! Please open an issue or submit a pull request on the GitHub repository.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Disclaimer

This extension is not affiliated with or endorsed by Quarto or its maintainers.