Content

Files present in this repository can be grouped in two categories:

• files required by Quarto to generate the presentation,
• files used to describe the GitHub repository.

Quarto files

• 📄 index.qmd: the content of the Quarto presentation (including configuration options).
• 📁 sections: (optional) a folder used to store sections (.qmd files) of the Quarto presentation. These .qmd files must be linked in the index.qmd. Using sections is optional and all content of the presentation can be written in index.qmd. Here, we split the presentation in 3 sections:
  • 📄 title-slide.qmd: a .qmd file for the first slide (title slide).
  • 📄 table-of-contents.qmd: a .qmd file for the table of contents that can be reused in the presentation (if required).
  • 📄 quarto-basics.qmd: a .qmd file the main content of the presentation.
• 📁 images: a folder used to store images for Quarto presentation. It contains also two subfolders:
  • 📁 readme: images used in the README.md.
  • 📁 wiki: images used in the Wiki.
• 📁 styles: a folder used to store .css and .scss files defining the theme of the presentation (main.scss). These .css and .scss are linked in the index.qmd (section theme of the YAML header).
• 📁 _extensions: a folder used to store Quarto extensions used in the presentation. It contains two extensions:
  • 📁 quarto-ext/fontawesome: a Quarto extension used to insert Font Awesome icons.
  • 📁 schochastics/academicons: a Quarto extension used to insert Academicons icons.

Repository files

• 📄 README.md: a markdown file describing the repository.
• 📄 LICENSE.md: a markdown file with the license content (default is CC BY 4.0).
• 📄 CODE_OF_CONDUCT.md: a markdown file describing the code of conduct for contributors.
• 📄 CONTRIBUTING.md: a markdown file describing how contributors can help and be involved in this project.
• 📄 _quarto.yml: the Quarto configuration file (required by the GitHub Action to render the presentation).
• 📁 .github: a folder used to store files specific to GitHub. It contains two subfolders: (e.g. automatically render the .qmd files after a git push).
  • 📁 ISSUE_TEMPLATE: a folder containing Issue templates written in markdown.
  • 📁 workflows: a folder containing configuration files (yaml files) to define GitHub Actions. It contains only one GitHub action:
    • 📄 quarto-render.yml: an 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.