generated from Openscapes/quarto-website-tutorial
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit fd6f017
Showing
87 changed files
with
10,828 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
.Rproj.user | ||
.Rhistory | ||
.RData | ||
.Ruserdata | ||
|
||
/.quarto/ | ||
*_cache/ | ||
_site/ | ||
|
||
.DS_Store |
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
# quarto-site-template | ||
Example quarto site without R or Python! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Large diffs are not rendered by default.
Oops, something went wrong.
Oops, something went wrong.