Skip to content

Latest commit

 

History

History
24 lines (14 loc) · 2.05 KB

README.md

File metadata and controls

24 lines (14 loc) · 2.05 KB
Raw

Try without installing anything. Make sure to make click the Make a Copy button or you will lose all your changes.

NOAA quarto simple website

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 webpage will use 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.

GitHub Set-up

  • Click the green "Use This 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).

image

  • Turn on GitHub Pages under Settings > Pages . You will set pages to be made from the gh-pages branch and root directory.

image

  • Turn on GitHub Actions under Settings > Actions > General

image

  • 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 to the Quarto website

Customize

  • Edit the qmd or md files in the content folder. qmd files can include code (R, Python, Julia) and lots of Quarto markdown bells and whistles (like call-outs, cross-references, auto-citations and much more).
  • Add the files to _quarto.yml