generated from biodiversitydata/quarto-template
-
Notifications
You must be signed in to change notification settings - Fork 2
Content
Nicolas Casajus edited this page Nov 10, 2024
·
4 revisions
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.yml: the main Quarto configuration file (only used to define the title of the HTML page). - π
index.qmd: the content of the Quarto presentation (including some configuration options). - π
sections: (optional) a folder used to store sections (.qmdfiles) of the Quarto presentation. These.qmdfiles must be linked in theindex.qmd. Using sections is optional and all content of the presentation can be written inindex.qmd. Here, we split the presentation in 3 sections:- π
title-slide.qmd: a.qmdfile for the first slide (title slide). - π
table-of-contents.qmd: a.qmdfile for the table of contents that can be reused in the presentation (if required). - π
quarto-basics.qmd: a.qmdfile the main content of the presentation.
- π
- π
images: a folder used to store images for Quarto presentation. It contains also two subfolders: - π
styles: a folder used to store.cssand.scssfiles defining the theme of the presentation (main.scss). These.cssand.scssare linked in theindex.qmd(sectionthemeof 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.
- π
- π
README.md: amarkdownfile describing the repository. - π
LICENSE.md: amarkdownfile with the license content (default is CC BY 4.0). - π
CODE_OF_CONDUCT.md: amarkdownfile describing the code of conduct for contributors. - π
CONTRIBUTING.md: amarkdownfile describing how contributors can help and be involved in this project. - π
.github: a folder used to store files specific to GitHub. It contains two subfolders:- π
ISSUE_TEMPLATE: a folder containing Issue templates written inmarkdown. - π
workflows: a folder containing configuration files (yamlfiles) to define GitHub Actions. It contains only one GitHub action:- π
quarto-render.yml: an action that will automatically convert theindex.qmdinto anindex.htmland push presentation files on thegh-pagesbranch. This action is triggered after a push on themainbranch.
- π
- π