s# Markdown Slide Master

This repository contains a template for creating slides and books using Quarto. It is designed to be used as a starting point for your own courses in HES-SO Valais-Wallis style.

The repository includes Continous Integration (CI) configuration for automatic deployment of the book and slides to GitHub Pages. The individual GitHub Pages should then be linked on moodle.

The output generated by this template is available at https://duerrsimon.github.io/hevs-quarto/.

How to use this template

1. Create a new repository from this template on GitHub
2. Either locally or on Github, edit the quarto.yml file to set the title, author, and other metadata for your course.
3. Edit the index.qmd file to provide an overview of your course.
4. Edit the _quarto-book.yml file to set the book title, author, and other metadata. Also add your course structure in the chapters section.
5. Modify the base_url in _variables.yml. it should be githubusername.github.io/reponame/
6. Add your course content in the Week1, Week2, etc. directories, following the structure of the provided example.

The quarto documentation is available at https://quarto.org/docs/.

Note that you can exempt certain parts of the document to show up in the public material by using

::: {.onlyteacher}
Your content here
:::

How to locally preview and render the book and slides

For course development, you can preview and render the book and slides locally using Quarto. For production use and deployment, it is recommended to use the CI/CD pipeline provided in this repository.

Install Quarto

Follow the instructions at https://quarto.org/docs/get-started/ to install Quarto on your system.

Live preview of a single slide set

quarto preview Week1/slides.md

Live preview of the book

quarto preview --profile book

Generate book and slides locally

quarto render --profile book

The files will be generated in the _book directory. You can then open the index.html file in your browser to view the book. The slides will be generated in the _slides folder.

Additionally a PDF of the book will be generated.

GitHub Actions will automatically also generate a PDF version of the slides.