Skip to content

Latest commit

 

History

History
68 lines (39 loc) · 1.66 KB

File metadata and controls

68 lines (39 loc) · 1.66 KB

Quarto Docs

Prerequisites

Quarto

We need to install Quarto onto your local machine. You can download, or install via homebrew (if you like that kind of thing):

brew install --cask quarto

If you use VS Code, you can also consider installing the Quarto Extension.

Setup

Fork the repo. Clone your copy of the repo onto your computer and navigate to it from the command line.

Setup virtual environment (if you like that kind of thing):

conda create -n quarto-env python=3.10
conda activate quarto-env

Install package dependencies:

#pip install -r requirements.txt
pip install -r docs/requirements.txt

Initialization

FYI the following command was used to initialize the quarto config:

#quarto create book

In the docs/_quarto.yml file, the output directory was changed from _book to _build to standardize across projects, enabling the usage of common workflow files and makefile.

Building

Previewing the site (runs like a local webserver):

quarto preview docs/

Rendering the site (writes local HTML files to the "docs/_build" directory, which is ignored from version control):

quarto render docs/ --verbose

GitHub Actions Workflows

Website Publishing

We are using the "deploy.yml" workflow configuration file to deploy the site to GitHub Pages when new commits are pushed to the main branch.

In order for this to work, you first need to configure your GitHub Pages repo settings to publish via GitHub Actions.