Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
stefaniebutland authored May 10, 2024
0 parents commit fd6f017
Show file tree
Hide file tree
Showing 87 changed files with 10,828 additions and 0 deletions.
30 changes: 30 additions & 0 deletions .github/workflows/quarto-publish.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
on:
push:
branches: main

name: Render and Publish

jobs:
build-deploy:
runs-on: ubuntu-latest
steps:
- name: Check out repository
uses: actions/checkout@v2

- name: Set up Quarto
uses: quarto-dev/quarto-actions/setup@v2
with:
# To install LaTeX to build PDF book
tinytex: true
# uncomment below and fill to pin a version
# version: 0.9.600

# add software dependencies here

- name: Publish to GitHub Pages (and render)
uses: quarto-dev/quarto-actions/publish@v2
with:
target: gh-pages
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # this secret is always available for github actions

10 changes: 10 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
.Rproj.user
.Rhistory
.RData
.Ruserdata

/.quarto/
*_cache/
_site/

.DS_Store
395 changes: 395 additions & 0 deletions LICENSE

Large diffs are not rendered by default.

2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# quarto-site-template
Example quarto site without R or Python!
61 changes: 61 additions & 0 deletions _quarto.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
project:
type: website

website:
page-navigation: true
title: "Making sharable documents with Quarto"
site-url: "https://openscapes.github.io/quarto-website-tutorial"
repo-url: https://github.com/openscapes/quarto-website-tutorial
repo-actions: [edit, issue]

page-footer:
right: "This page is built with ❤️ and [Quarto](https://quarto.org/)."
left: "© CC-By Openscapes, 2024"

sidebar:
logo: "images/openscapes_hex.png"
pinned: true
align: center
tools:
- icon: globe
href: https://openscapes.org
text: "Openscapes.org"
- icon: github
href: https://github.com/openscapes/quarto-website-tutorial
text: "Quarto website tutorial"
- icon: twitter
href: https://twitter.com/openscapes
text: "Openscapes Twitter"

style: "docked"
search: true
collapse-level: 1
contents:
- href: index.qmd
text: Welcome
- explore.qmd
- section: quarto-workflows/index.qmd
contents:
- quarto-workflows/browser.md
- quarto-workflows/rstudio.qmd
- quarto-workflows/jupyter.md
- learning-more.qmd
- href: transition-from-rmarkdown.qmd
text: Transition from Rmd


format:
html:
theme:
light: [cosmo, theme.scss] # from https://github.com/sta210-s22/website/blob/main/_quarto.yml
dark: [cosmo, theme-dark.scss]
code-copy: true
code-overflow: wrap
toc: true


filters:
- include-files.lua
- quarto


23 changes: 23 additions & 0 deletions _render-vs-preview.qmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: Render vs. Preview
---

Making quarto websites involves terminology that might be unfamiliar. This is a light explainer to help you get going.

As you work locally, you will save your files as you normally do. Saving writes your work to disk.

## Render

Rendering is when Quarto formats your document into something different (e.g. .html or .docx).

## Preview

Preview is when Quarto displays the rendered files. It's like saying "show me".

## When do I want Render vs Preview?

From the RStudio IDE, the "Render" button does both Render + Preview together.

From Jupyter, you'll need to do these in two steps, render to make the formatted document, and preview to view it.

From GitHub.com, Quarto will only be able to render when published (through a GitHub Action). This means you cannot preview before publishing online.
Binary file added _site/images/github-action-green.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _site/images/github-action-orange.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _site/images/github-edit-readme.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _site/images/github-source-gh-pages.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _site/images/openscapes_hex.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _site/images/quarto-files-github.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _site/images/quarto-yml-site-side-by-side2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
609 changes: 609 additions & 0 deletions _site/index.html

Large diffs are not rendered by default.

Loading

0 comments on commit fd6f017

Please sign in to comment.