Skip to content
Ben Tupper edited this page Jan 6, 2025 · 1 revision

Quarto

Quarto provides a simple super way to turn your text and code into a web page hosted by github. We have written all of our courseware using Quarto. Since you have a fork of the upstream repository you make your own website of the courseware.

You’ll note in the upstream repository that we have files like “index.qmq”, “C00_coding.qmd”, etc. Each of these is really just a RMarkdown file - prose, graphics and code embedded in simple text document. Along with a configuration file these are enough to organize the documents into a clean and simple webpage.

Copy a quarto document

We encourage you to consider copying these pages and populating the outputs with your own information. For example, suppose you were to duplicate `C01_observations.qmd’ as ‘S01_observations.qmd’ (where ‘S’ could be any letter, but we picked it for ‘Student’). After opening it, change the header info and species to your own species selection.

Modify the configuration _quarto.yml

Next modify the configuration file in two places: rendering order and website sidebar navigation as shown below.

project:
  type: website
  output-dir: docs
  execute-dir: project
  render:
    - index.qmd
    - C00_coding.qmd
    - C01_observations.qmd
    - C02_background.qmd
    - C03_covariates.qmd
    - C04_models.qmd
    - C05_prediction.qmd
    - S01_observations.qmd     #<--- here
    - about.qmd
execute: 
  cache: false

website:
  title: "Colby Forecasting 2025"
  page-navigation: true
  back-to-top-navigation: true
  page-footer: "Copyright 2025, Bigelow Laboratory for Ocean Science" 
  sidebar:
    style: "docked"
    search: true
    contents:
      - text: Home
        href: index.qmd
      - text: Coding
        href: C00_coding.qmd
      - text: Observations
        href: C01_observations.qmd
      - text: Background
        href: C02_background.qmd
      - text: Covariates
        href: C03_covariates.qmd
      - text: Models
        href: C04_models.qmd
      - text: Prediction
        href: C05_prediction.qmd
      - text: My Observations         #<--- here
        href: S01_observations.qmd    #<--- here
      - text: About
        href: about.qmd
    tools:
      - icon: github
        menu:
          - text: Source Code
            url:  https://github.com/BigelowLab/ColbyForecasting2025
          - text: Report a bug or ask a question
            url:  https://github.com/BigelowLab/ColbyForecasting2025/issues
          - text: Wiki
            url:  https://github.com/BigelowLab/ColbyForecasting2025/wiki
format:
  html:
    theme: cosmo
    css: styles.css
    toc: true
    number-sections: true

editor: source

Add, commit and push to github

Now add your new file to the local git repository, make a commitment and push the changes.

Configure your personal github repository to host the pages

Follow the render to docs instructions.

Wait a bit

It takes some time for github’s servers to test and deplot your pages, but when it is done it will tell you what you website link is.

Clone this wiki locally