CIRES Lab Manual

CIRES Ocean Acoustics Lab Manual Setup

This repository serves as the documentation for the CIRES Ocean Acoustics Lab Manual, built using Quarto and hosted via GitHub Pages. If you would like to replicate this setup for your projects, follow the instructions below.

This is a common format for documentation and includes a GitHub Action that automatically builds the website when changes are made. The NOAA palette and fonts have been added to theme.scss for consistent branding. The website will be served from the gh-pages branch, a common approach to prevent cluttering the main branch with website files.

The GitHub Action installs R to support R code in your .qmd or .Rmd files. There’s no need to modify existing.Rmd files unless you want to use specific Quarto features like cross-referencing.

GitHub Setup

  • Use the Template Click the green “Use This Template” button to create a repository with this content. Ensure your repository is public (GitHub Pages doesn’t work for private repositories unless you have a paid account). Also, check the box to include all branches to get the gh-pages branch. image

  • Enable GitHub Pages Go to Settings > Pages, and set the source to be the gh-pages branch and the root directory for the site. image

  • Enable GitHub Actions Under Settings > Actions > General, make sure GitHub Actions are enabled. image

  • Edit Repository Description Add a description and a link to the webpage in the repository’s settings. You can find the URL by going to the Settings > Pages section or under the Actions tab once the website is built.