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 from the Quarto Extensions registry, GitHub repositories, URLs, or local paths. This extension provides a user-friendly interface to browse, select, and install Quarto extensions, enhancing your Quarto development experience.

Key Features

• Browse and install Quarto extensions from Registry, GitHub, URL, or Local sources.
• Use dedicated install commands for each source (including owner/repo@version on GitHub).
• Manage installed extensions from the Explorer view (update, reinstall, remove, reveal, open source).
• Inspect extension schema metadata and insert extension snippets from the Explorer view.
• Batch-manage extensions with "Update All", "Remove Multiple", and cache refresh.
• Use Quarto templates with target subdirectory support and file selection.
• Use Quarto brands from GitHub, URL, or local sources.
• Create reproducible documents for R, Python, or Julia.
• Support for private GitHub repositories with authentication.

Install Quarto Extensions

1. Open the Command Palette and run Quarto Wizard: Install Extensions.
2. Choose a source: Registry, GitHub, URL, or Local.
3. Select one or more extensions and confirm installation.

You can also skip the source picker with:

• Quarto Wizard: Install Extension from Registry
• Quarto Wizard: Install Extension from GitHub
• Quarto Wizard: Install Extension from URL
• Quarto Wizard: Install Extension from Local

For full install options (including local archives and version validation), see Installing Extensions.

Quarto Wizard Explorer View

Use the Extensions Installed Explorer view to:

• Check installed extension status and available updates.
• Update one extension or all outdated extensions.
• Remove one or multiple extensions.
• Inspect schema contributions (options, shortcodes, formats, projects, and element attributes).
• Insert extension snippets directly into the active editor.

See Explorer View for details.

Use Quarto Templates

Run Quarto Wizard: Use Template, choose a source, then select template files to copy. You can optionally set a target subdirectory for copied files.

See Using Templates.

Use Quarto Brand

Run Quarto Wizard: Use Brand, choose a source (GitHub, URL, or Local), and apply brand assets to your project. Brand files are installed in _brand/.

See Using Brands.

Installation

Search for "Quarto Wizard" in the VS Code/Positron Extensions view and click Install.

For other installation methods, see the Installation Guide.

Documentation

Full documentation is available at m.canouil.dev/quarto-wizard.

• Getting Started - Installation, usage, and troubleshooting.
• Commands Reference - Commands.
• Configuration - Available settings, defaults, and workspace scope.
• Extension Schema Specification - For extension developers: _schema.yml format for hover details, suggestions, and validation.
• Extension Snippet Specification - For extension developers: _snippets.json format for snippet suggestions and insertion.

Getting Help

If you experience issues or have questions:

1. Check the output log: Quarto Wizard: Show Quarto Wizard Log Output.
2. Search existing discussions and issues: GitHub Discussions and GitHub Issues.
3. Ask a question or share feedback: Use the Discussion chooser to select the appropriate category.
4. Report a bug: Use the Issue chooser to create a bug report with the provided template.

Tip

Please use the chooser menus to select the right place for your request. This ensures efficient handling and helps maintainers respond appropriately.

Verifying Release Asset Build Provenance

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

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.

Credits

Quarto Wizard is developed by Mickaël CANOUIL (mickael.canouil.fr).

• Built for the Quarto CLI ecosystem.
• Extension registry: Quarto Extensions.
• All contributors.

Full credits.

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.