Skip to content

README.md

Latest commit

 

History

History
129 lines (92 loc) · 3.87 KB

README.md

File metadata and controls

129 lines (92 loc) · 3.87 KB

Quarto CLI (quarto-cli)

Installs the Quarto CLI. Auto-detects latest version.

Example Usage

"features": {
    "ghcr.io/rocker-org/devcontainer-features/quarto-cli:1": {}
}

Options

Options Id Description Type Default Value
version Select version of the Quarto CLI, if not latest. string latest
installTinyTex Install TinyTeX by using the quarto install tinytex command. Works only with version 1.2 or later. boolean false
installChromium Run the quarto install chromium or quarto install chrome-headless-shell command. Check the document for details. boolean false

Customizations

VS Code Extensions

  • quarto.quarto

Supported platforms

linux/amd64 and linux/arm64 platform debian and ubuntu.

linux/arm64 platform only supports version 1.3 or later.

Execution Engine

This feature will not install execution engines such as jupyter or knitr, so if you wish to use them, please install them separately.

For example, set postCreateCommand to install jupyter on mcr.microsoft.com/devcontainers/python:

{
    "image": "mcr.microsoft.com/devcontainers/python:3",
    "features": {
        "ghcr.io/rocker-org/devcontainer-features/quarto-cli:latest": {}
    },
    "postCreateCommand": "python3 -m pip install jupyter"
}

Install Chromium

Chromium may be required to render documents containing diagrams code blocks such as {mermaid} and {dot} into non-HTML formats.

To do this in a Docker container, besides specifying the installChromium option of this Feature, we also need to install necessary shared library dependencies of Chromium.

On Debian, this can be done with installing Chromium via devcontainer.json as follows using the ghcr.io/rocker-org/devcontainer-features/apt-packages Feature.

{
    "image": "mcr.microsoft.com/devcontainers/base:debian",
    "features": {
        "ghcr.io/rocker-org/devcontainer-features/quarto-cli:1": {
            "installChromium": true
        },
        "ghcr.io/rocker-org/devcontainer-features/apt-packages:1": {
            "packages": "chromium"
        }
    }
}

Unfortunately, this does not work for Ubuntu because it is not possible to install Chromium via apt.

On Ubuntu, we need to install missing dependencies by either. For example:

{
    "image": "mcr.microsoft.com/devcontainers/base:ubuntu",
    "features": {
        "ghcr.io/rocker-org/devcontainer-features/quarto-cli:1": {
            "installChromium": true
        },
        "ghcr.io/rocker-org/devcontainer-features/apt-packages:1": {
            "packages": "libgtk-3-dev,libnotify-dev,libgconf-2-4,libnss3,libxss1,libasound2"
        }
    }
}

The dependent package list came from the Puppeteer document and might get outdated.

See also: https://pptr.dev/troubleshooting#running-puppeteer-in-docker

Available versions

"latest" and "prerelease" refer to the release and pre-release versions listed in the Quarto CLI's download page.

You can also specify a version number, like "1", "1.2", "1.0.38".

"1" matches the highest numbered tag has pattern 1.Y.Z in the Quarto CLI GitHub repository.

{
    "image": "mcr.microsoft.com/devcontainers/base:debian",
    "features": {
        "ghcr.io/rocker-org/devcontainer-features/quarto-cli:latest": {
            "version": "1"
        }
    }
}

References

Note: This file was auto-generated from the devcontainer-feature.json. Add additional notes to a NOTES.md.