Installing

Instructions for installing the required (and optional) programs to use this template and create a new Quarto-based website project from it.

There are a few programs that are required to use this template to create a website project:

• uv: A tool for managing Python environments and running commands.
• Python: Required by Copier, the template tool.
• Copier: A template tool for making new projects in a standardised and structured way.
• just: A build and development management tool that helps with running common build and check tasks.

You can use uv to install these required programs, so install that first. After you’ve installed uv, install the other programs using:

Terminal

uv tool install copier rust-just

uv will also install Python for you when you install these tools.

If you write any Python or R code in your website project, we recommend you install these programs as well to format and check your code inside your Quarto files:

Terminal

# For R code
uv tool install jarl-linter air-formatter
# For Python code
uv tool install ruff

There are some optional, though strongly recommended, programs to install and use in any website project created with this template:

• Git: For version control and setting up Git to track the newly created website project.
• Lychee: A link checker that we include in the justfile for checking for broken links in the files.
• Quarto: A scientific and technical publishing system built on Pandoc. The website built with this template is created with Quarto, and the website project created from this template is also set up to use Quarto too.
• gh cli: For managing GitHub repositories and settings from the command line. There are some post-creation steps we’ve included that use gh to simplify setting up a GitHub repository for the website project.