Skip to content

Commit

Permalink
Built site for gh-pages
Browse files Browse the repository at this point in the history
  • Loading branch information
Quarto GHA Workflow Runner committed Sep 10, 2024
1 parent 04513e8 commit 85a98b8
Show file tree
Hide file tree
Showing 10 changed files with 73 additions and 55 deletions.
2 changes: 1 addition & 1 deletion .nojekyll
Original file line number Diff line number Diff line change
@@ -1 +1 @@
c83c54a9
c5515473
15 changes: 7 additions & 8 deletions apa7_manuscript.html

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions get-started_1.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions get-started_2.html

Large diffs are not rendered by default.

12 changes: 6 additions & 6 deletions get-started_3.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions index.html

Large diffs are not rendered by default.

20 changes: 16 additions & 4 deletions search.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
"href": "apa7_manuscript.html#getting-started",
"title": "Exercise: Formatting Quarto documents in APA 7 style",
"section": "Getting started",
"text": "Getting started\nCurrently, there is no official Quarto extension to format documents according to the APA 7 guidelines1. However, the inofficial apaquarto extension can be utilized until better options emerge2. After installing it into the current project, we can set the format to apaquarto-pdf or apaquarto-docx. Here are the detailed steps that are necessary to create a manuscript in APA 7 style – skip step 1 if you want to use an existing Quarto document.\n\nPrerequisites\n\nInstall required packages\n\nClick on Console\nEnter\n\ninstall.packages(c(\"rmarkdown\", \"conflicted\", \"tidyverse\", \"flextable\", \"ftExtra\"))\n\nInstall TinyTeX\n\nClick on Terminal\nEnter quarto install tinytex\n\n\noptional: Create a new Quarto Document\n\nClick on File > New File > Quarto Document\nFill Title and Author\nChoose PDF\nClick Create\n\nAdd APA 7 Quarto extension\n\nGo to Terminal\nEnter quarto add wjschne/apaquarto\nConfirm installation by entering Y twice, then avoid opening the documentation by entering n\nIf you want to update the extension at a later point, enter quarto update wjschne/apaquarto\n\nDeclare the language of the document by setting e.g. lang: en in the YAML header (see the Quarto documentation on document language for more information)\nChange format as follows:\n\nformat:\n apaquarto-pdf:\n documentmode: man\n a4paper: true\n pdf-engine: lualatex\n keep-tex: false\nClick on the disk symbol to save (maybe call the file manuscript.qmd)\nClick on Render\n(alternatively, go to the Terminal and enter quarto render manuscript.qmd)\n\nWe can now provide additional information in the YAML header as detailed below.",
"text": "Getting started\nThe official Quarto extension apaquarto can be used to format documents according to the APA 7 guidelines1. After installing the extension into the current project, we can set the format to apaquarto-pdf or apaquarto-docx. Here are the detailed steps that are necessary to create a manuscript in APA 7 style (Note: skip step 1 if you want to use an already existing Quarto document).\n\nPrerequisites\n\nInstall required packages\n\nClick on Console\nEnter\n\ninstall.packages(c(\"rmarkdown\", \"conflicted\", \"tidyverse\", \"flextable\", \"ftExtra\"))\n\nInstall TinyTeX\n\nClick on Terminal\nEnter quarto install tinytex\n\n\nOptional: Create a new Quarto Document\n\nClick on File > New File > Quarto Document\nFill Title and Author\nChoose PDF\nClick Create\n\nAdd APA 7 Quarto extension\n\nGo to Terminal\nEnter quarto add wjschne/apaquarto\nConfirm installation by entering Y twice, then avoid opening the documentation by entering n\nIf you want to update the extension at a later point, enter quarto update wjschne/apaquarto\n\nDeclare the language of the document by setting e.g. lang: en in the YAML header (see the Quarto documentation on document language for more information)\nChange format as follows:\n\nformat:\n apaquarto-pdf:\n documentmode: man\n a4paper: true\n pdf-engine: lualatex\n keep-tex: false\nClick on the disk symbol to save (maybe call the file manuscript.qmd)\nClick on Render\n(alternatively, go to the Terminal and enter quarto render manuscript.qmd)\n\nWe can now provide additional information in the YAML header as detailed below.",
"crumbs": [
"1. Welcome",
"4. Advanced Exercises",
Expand Down Expand Up @@ -124,7 +124,7 @@
"href": "apa7_manuscript.html#footnotes",
"title": "Exercise: Formatting Quarto documents in APA 7 style",
"section": "Footnotes",
"text": "Footnotes\n\n\nFor a list of official Quarto extensions, see Journal Articles.↩︎\nOne can follow the discussion on GitHub at quarto-journals/article-format-template#11↩︎",
"text": "Footnotes\n\n\nFor a list of Quarto extensions for specific journal formats, click here.↩︎",
"crumbs": [
"1. Welcome",
"4. Advanced Exercises",
Expand Down Expand Up @@ -810,9 +810,21 @@
{
"objectID": "webr.html",
"href": "webr.html",
"title": "Exercise: Create a website with Quarto, WebR/Pyodide, and Github Pages, to use R/Python on your smartphone or tablet",
"title": "Exercise: Create a website with Quarto, WebR (or Pyodide), and Github Pages to use R (or Python) on your smartphone or tablet",
"section": "",
"text": "Description\nIn this exercise you can practice how to\n\nhost a Quarto website with Github Pages\nuse WebR/Pyodide in a Quarto document that allows you to run R/Python in your browser\n\nThe final result of the exercise is a website on which you can run R/Python directly in your browser, without having it installed on your device like your smartphone or tablet.\nYou can just follow our step-by-step instructions or have a look at the relevant documentation we link to in the blue boxes.\n\n\nFinal result\nThe final result of the exercise using webR could look something like this:\n\nWebsite\nCode\n\n\n\nStep by step instructions\n\nLog into your Github account and create a new public Github repository\n\n\n\n\n\n\nNote\n\n\n\n\nIf you need a refresher on how to work with Git and Github you can checkout the following two self-paced online tutorials:\n\nIntroduction to version Control in R with RStudio, Git, and Github\nCollaborative coding with GitHub and RStudio\n\nYou can find a screenshot of how to create a new repository here\n\n\n\nCreate a new project in RStudio\n\n\n\n\n\n\nNote\n\n\n\nYou can find a screenshot of how to create a new project here\n\n\n\nClick File > New Project > Version control > Git\nGo to your Github repository, click on Code and copy the HTTPS URL to the clipboard\nIn RStudio, insert the URL into the Repository URL field\nOptional:\n\nYou can leave the Project directory field blank to adopt the name of the Github repository\nYou can click on Open in new session to avoid closing your original RStudio session\n\nClick Browse to select where to save the project on your computer\nClick Create Project\n\nDownload the webR Quarto extension\n\n\n\n\n\n\nNote\n\n\n\nYou can find the quarto-webr documentation here\n\n\n\nOpen the terminal in RStudio\nInstall the Quarto extension with the following code:\nquarto add coatless/quarto-webr\nAnswer Yes that you trust the author\nAnswer Yes that you want to install the webR filter\nAnswer Yes if you now want to open the quarto-webr documentation in your default browser (you do not have to)\nYou should now have a folder _extensions/coatless/webr in your project directory\n\nDownload the Pyodide Quarto extension\n\n\n\n\n\n\nNote\n\n\n\nYou can find the quarto-pyodide documentation here\n\n\n\nOpen the terminal in RStudio\nInstall the Quarto extension with the following code:\nquarto add coatless-quarto/pyodide\nAnswer Yes that you trust the author\nAnswer Yes that you want to install the pyodide filter\nAnswer Yes if you now want to open the pyodide documentation in your default browser (you do not have to)\nYou should now have a folder _extensions/coatless-quarto/pyodide in your project directory\n\nCreate a new Quarto document, named e.g. mywebr.qmd\n\nIn RStudio, click File > New File > Quarto Document\nAdd the following options to the YAML header (only add the filter relevant to you):\nformat: html\nengine: knitr\nfilters:\n - webr\n - pyodide\nInteractive R chunks must be formatted like this:\n```{webr-r}\n```\nInteractive Python chunks must be formatted like this:\n```{pyodide-python}\n```\nDeclare the language of the document by setting e.g. lang: en in the YAML header (see the Quarto documentation on document language for more information)\nAdd some text or other things you want to see on your Quarto website\n\nCheck that the file mywebr.qmd renders successfully locally. In RStudio you can just click the Render button\n\n\n\n\n\n\nNote\n\n\n\nYou might face the issue that the status remains at Loading… because your browser restricts certain features of local files. In this case, spin up a simple web server by running one of the following, go to http://localhost:8000/ and click on mywebr.html:\nRscript -e \"servr::httd(port = 8000)\"\npython -m http.server 8000\n\n\nWhen you are finished with your Quarto document and everything renders correctly, you can commit the file mywebr.qmd and the folder _extensions/coatless to your git repository and push your changes to your Github project (this step is recommended but optional)\n\n\n\n\n\n\nNote\n\n\n\n\nYou can find a screenshot on how to commit changes in RStudio here\nYou can find a screenshot on hot to push commits in RStudio here\n\n\n\nUpload the website to Github pages\n\n\n\n\n\n\nNote\n\n\n\nYou can find the documentation on how to publish Quarto websites on Github pages here\n\n\n\nPublish your website (based on the file mywebr.qmd) by running the following command in the terminal within RStudio. This will commit the rendered website to a Github branch named gh-pages:\nquarto publish gh-pages mywebr.qmd\nAnswer Yes that you want to upload the website to Github Pages\nWhen ready, a browser window should open automatically",
"text": "In this exercise you can practice how to:\n\nHost a Quarto website with Github Pages\nUse WebR in a Quarto document that allows you to run R in your browser\nOptional. Use Pyodide to run Python\n\nThe final result of the exercise is a website on which you can run R (or Python) directly in your browser, without having it installed on the device like your smartphone or tablet.\nYou can just follow our step-by-step instructions or have a look at the relevant documentation we link to in the blue boxes.",
"crumbs": [
"1. Welcome",
"4. Advanced Exercises",
"Exercise: WebR/Pyodide"
]
},
{
"objectID": "webr.html#footnotes",
"href": "webr.html#footnotes",
"title": "Exercise: Create a website with Quarto, WebR (or Pyodide), and Github Pages to use R (or Python) on your smartphone or tablet",
"section": "Footnotes",
"text": "Footnotes\n\n\nThis example only showcases R in the browser with webR, but the following sections also describe how to run Python with Pyodide.↩︎",
"crumbs": [
"1. Welcome",
"4. Advanced Exercises",
Expand Down
30 changes: 15 additions & 15 deletions sitemap.xml
Original file line number Diff line number Diff line change
Expand Up @@ -2,62 +2,62 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://lmu-osc.github.io/introduction-to-Quarto/apa7_manuscript.html</loc>
<lastmod>2024-09-10T13:47:46.092Z</lastmod>
<lastmod>2024-09-10T14:04:03.245Z</lastmod>
</url>
<url>
<loc>https://lmu-osc.github.io/introduction-to-Quarto/get-started_2.html</loc>
<lastmod>2024-09-10T13:47:46.120Z</lastmod>
<lastmod>2024-09-10T14:04:03.277Z</lastmod>
</url>
<url>
<loc>https://lmu-osc.github.io/introduction-to-Quarto/index.html</loc>
<lastmod>2024-09-10T13:47:46.120Z</lastmod>
<lastmod>2024-09-10T14:04:03.277Z</lastmod>
</url>
<url>
<loc>https://lmu-osc.github.io/introduction-to-Quarto/comments.html</loc>
<lastmod>2024-09-10T13:47:46.092Z</lastmod>
<lastmod>2024-09-10T14:04:03.245Z</lastmod>
</url>
<url>
<loc>https://lmu-osc.github.io/introduction-to-Quarto/preparations.html</loc>
<lastmod>2024-09-10T13:47:46.140Z</lastmod>
<lastmod>2024-09-10T14:04:03.293Z</lastmod>
</url>
<url>
<loc>https://lmu-osc.github.io/introduction-to-Quarto/links.html</loc>
<lastmod>2024-09-10T13:47:46.140Z</lastmod>
<lastmod>2024-09-10T14:04:03.293Z</lastmod>
</url>
<url>
<loc>https://lmu-osc.github.io/introduction-to-Quarto/quarto_exercises.html</loc>
<lastmod>2024-09-10T13:47:46.140Z</lastmod>
<lastmod>2024-09-10T14:04:03.293Z</lastmod>
</url>
<url>
<loc>https://lmu-osc.github.io/introduction-to-Quarto/quarto_manuscripts.html</loc>
<lastmod>2024-09-10T13:47:46.140Z</lastmod>
<lastmod>2024-09-10T14:04:03.293Z</lastmod>
</url>
<url>
<loc>https://lmu-osc.github.io/introduction-to-Quarto/presentation.html</loc>
<lastmod>2024-09-10T13:47:46.140Z</lastmod>
<lastmod>2024-09-10T14:04:03.293Z</lastmod>
</url>
<url>
<loc>https://lmu-osc.github.io/introduction-to-Quarto/get-started_3.html</loc>
<lastmod>2024-09-10T13:47:46.120Z</lastmod>
<lastmod>2024-09-10T14:04:03.277Z</lastmod>
</url>
<url>
<loc>https://lmu-osc.github.io/introduction-to-Quarto/slideshow.html</loc>
<lastmod>2024-09-10T13:47:46.160Z</lastmod>
<lastmod>2024-09-10T14:04:03.317Z</lastmod>
</url>
<url>
<loc>https://lmu-osc.github.io/introduction-to-Quarto/quarto_tutorials.html</loc>
<lastmod>2024-09-10T13:47:46.140Z</lastmod>
<lastmod>2024-09-10T14:04:03.293Z</lastmod>
</url>
<url>
<loc>https://lmu-osc.github.io/introduction-to-Quarto/get-started_1.html</loc>
<lastmod>2024-09-10T13:47:46.120Z</lastmod>
<lastmod>2024-09-10T14:04:03.277Z</lastmod>
</url>
<url>
<loc>https://lmu-osc.github.io/introduction-to-Quarto/about.html</loc>
<lastmod>2024-09-10T13:47:46.092Z</lastmod>
<lastmod>2024-09-10T14:04:03.245Z</lastmod>
</url>
<url>
<loc>https://lmu-osc.github.io/introduction-to-Quarto/webr.html</loc>
<lastmod>2024-09-10T13:47:46.160Z</lastmod>
<lastmod>2024-09-10T14:04:03.317Z</lastmod>
</url>
</urlset>
4 changes: 2 additions & 2 deletions slideshow.html

Large diffs are not rendered by default.

Loading

0 comments on commit 85a98b8

Please sign in to comment.