Skip to content

Commit

Permalink
Update index.qmd
Browse files Browse the repository at this point in the history
change index from default template
  • Loading branch information
ChristineStawitz-NOAA authored Dec 11, 2023
1 parent 974bda5 commit 8345866
Showing 1 changed file with 6 additions and 17 deletions.
23 changes: 6 additions & 17 deletions index.qmd
Original file line number Diff line number Diff line change
@@ -1,22 +1,11 @@
---
title: "NOAA quarto simple with R"
subtitle: "A simple Quarto webpage with a book layout"
title: "Fisheries Integrated Modeling System case studies"
subtitle: "Test cases, based on regional assessments, to illustrate use of FIMS"
page-layout: full
---

This is a template for a simple Quarto website that looks like a "book". This is a common format for documentation. It includes a GitHub Action that will build the website automatically when you make changes to the files. The NOAA palette and fonts has been added to `theme.scss`. The webpage will be on the `gh-pages` branch. Serving the website files from this branch is a common way to keep all the website files from cluttering your main branch.
These case studies demonstrate use of the Fisheries Integrated Modeling System to run a few different cases of stock assessment models.

The GitHub Action installs R so you can have R code in your qmd or Rmd files. Note, you do not need to make changes to your Rmd files unless your need Quarto features like cross-references.

## GitHub Set-up

* Click the green "use template" button to make a repository with this content. Make sure to make your repo public (since GitHub Pages doesn't work on private repos unless you have a paid account) and check box to include all the branches (so that you get the gh-pages branch).
<img width="637" alt="image" src="https://user-images.githubusercontent.com/2545978/197051535-c43c62de-17e8-40bf-a536-3eea8db250c4.png">

* Turn on GitHub Pages under Settings > Pages . You will set pages to be made from the gh-pages branch and root directory.
<img width="540" alt="image" src="https://user-images.githubusercontent.com/2545978/196808262-3d2262be-b9b5-4897-bba5-fc2f056dd335.png">

* Turn on GitHub Actions under Settings > Actions > General
<img width="719" alt="image" src="https://user-images.githubusercontent.com/2545978/196808404-0c075fcf-db03-4516-88dd-3143b9fca475.png">

* Edit the repo description and Readme to add a link to the webpage. When you edit the description, you will see the link url in the url box or you can click on the Actions tab or the Settings > Pages page to find the url.
```{r, eval = FALSE}
install.packages(c("dplyr","tidyr"))
```

0 comments on commit 8345866

Please sign in to comment.