Skip to content

Commit

Permalink
add quarto.yml & book screenshots
Browse files Browse the repository at this point in the history
  • Loading branch information
stefaniebutland committed Jul 19, 2022
1 parent 97c01b2 commit 77b423d
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 2 deletions.
Binary file added images/faylab-manual-quarto-yml.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 images/faylab-manual.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 10 additions & 2 deletions transition-from-rmarkdown.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Here are the main steps to convert the Faylab Lab manual from Bookdown to Quarto

Change all filename extensions `.Rmd` -\> `.qmd` (you could Preview after this change and see that the book looks the same).

Create new empty file called `_quarto.yml` and add book metadata there. Here's what ours looked like when we finished the steps below: [`_quarto.yml`](https://github.com/thefaylab/lab-manual/blob/main/_quarto.yml).
Create new empty file called `_quarto.yml` and add book metadata there.

Set project type as `book`.

Expand All @@ -36,6 +36,14 @@ Move chapters listing out of `_bookdown.yml` and into `_quarto.yml`.

Add page footer to `_quarto.yml`.

Here's what ours looked like when we finished the steps above. [`_quarto.yml`](https://github.com/thefaylab/lab-manual/blob/main/_quarto.yml).

::: {layout-ncol="2"}
![\_quarto.yml contents](images/faylab-manual-quarto-yml.png){fig-alt="_quarto.yml file contents" width=45%}

![Faylab Lab Manual](images/faylab-manual.png){fig-alt="screenshot of Lab Manual book" width=45%}
:::

Change insertion of images from html style to Quarto style. (Note Quarto calls them "figures", not "images".) The following snippet will insert the GitHub octocat logo in a page:

``` bash
Expand All @@ -54,7 +62,7 @@ Reload project

The Faylab Lab Manual cited two papers, presenting us with an opportunity to see how easy it is to add references to a Quarto book. Briefly, in the Visual Editor, Insert \> Citation \> DOI. Pasting the DOI or its full URL, we can insert the citation. This automatically creates a `references.bib` file and adds the full citations at the bottom of the chapter page. In July 2022, we had to manually add a `## References` heading, but this may not be necessary in future Quarto updates.

::: {layout-ncol=2}
::: {layout-ncol="2"}
![Insert citation via its DOI using RStudio Visual Editor](images/rstudio-insert-citation.png){fig-alt="RStudio Visual Editor Insert dropdown menu with Citation highlighted"}

![](images/rstudio-insert-citation-doi.png)
Expand Down

0 comments on commit 77b423d

Please sign in to comment.