Skip to content

Usage

Jump to bottom
Nicolas Casajus edited this page Sep 21, 2024 · 14 revisions

Prerequisites

If you want to render the slides locally, you need to install the following tools:

Repository metadata

Before starting writing your new presentation, you have to adapt the content of some files.

Author email

Change your email:

  • in the CONTRIBUTING.md
  • in the CODE_OF_CONDUCT.md
  • in the sections/title-slide.md

Repository name and URL

Change the repository name and URL:

  • in the README.md
  • in the CONTRIBUTING.md
  • in the CODE_OF_CONDUCT.md
  • in the YAML header of the index.qmd

Repository description

Adapt the content of the README.md to better describe your repository.

Title slide

Change the content (title, subtitle, authors, links and images) of the title slide in sections/title-slide.qmd. To change images, add new images in the images/ folder. Two images are currently used:

  • the logo-affiliation.png is used in the slide footer
  • the logo-title-slide.png is used in the title slide

License

If you want to use a different license (default is CC BY 4.0), you have to change:

  • the content of the LICENSE.md file
  • the license badge in the README.md

Wiki

When you use this template, the Wiki is also copied in your new repository. You may want to disable this Wiki. Go in the Settings of your repository and uncheck the Wiki option.

Editing slide content

File organization

The Quarto template splits the presentation (index.qmd) into sections (.qmd files stored in sections/). You can create as many sections as you like. You have to link a new section in the index.qmd as follow:

```{r}
#| child: "sections/new-section.qmd"
```

Alternatively, you can copy the content of all qmd files of the sections/ folder inside the index.qmd and delete the sections/ folder. But working with child qmd makes easier the writing process, especially if you have a long presentation or want to reuse some slides.

Theme

If you want to modify the default theme, change the content of the styles/main.scss file. Alternatively, you can create your own theme in a different scss file stored in styles/ and add a link to this file in the index.qmd:

theme: [default, "styles/new-theme.scss"]

Quarto syntax

If you are not familiar with the Quarto and RMarkdown syntax, you can have a look at the Quarto Guide.

Rendering slides locally

To locally render the slides, open the index.qmd in RStudio and click on the button Render. This will create an index.html containing your presentation. Open the index.html in your favorite web browser to see your slides.

Updating online slides

Presentation files (index.html and index_files/) are listed in the .gitignore to keep the main branch clean. Your online presentation will be generated by a GitHub Action that will automatically convert the index.qmd into an index.html and push presentation files on the gh-pages branch. This action is triggered after a push on the main branch.

After a few minutes, your online presentation will be available at: https://__ghaccount__.github.io/__reponame__, where __ghaccount__ is your GitHub account (or GitHub organization) and __reponame__ your repository name.

Note: You can disable the trigger of this action by adding [no ci] in your commit message. This can be interesting if you modify non Quarto files (e.g. README.md, CONTRIBUTING.md and CODE_OF_CONDUCT.md). For instance: git commit -m "edit README [no ci]".

Clone this wiki locally