Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 13 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,24 @@
# <span class="emoji">🎓</span> [AGH](https://www.agh.edu.pl/en) slide deck for [Quarto](https://quarto.org/docs/presentations/)/Jupyter/Python <span class="emoji">🐍</span>

This repo provides a single Jupyter/Python notebook file which can get you started with authoring a&nbsp;reproducible
<span class="emoji">💡</span> This repo provides a single Jupyter/Python notebook file which can get you started with authoring a&nbsp;reproducible
presentation in&nbsp;a&nbsp;template themed following [AGH University of Krakow](https://www.agh.edu.pl/en/)
[visual identity](https://www.agh.edu.pl/en/university/multimedia/graphic-symbol)
and [logo usage](https://www.agh.edu.pl/en/o-agh/multimedia/znak-graficzny-agh/znak-graficzny-bez-nazwy) guidelines.
It allows to&nbsp;tightly couple the code generating all figures and values in the slides with other presentation content

<span class="emoji">👩‍💻</span> It allows to&nbsp;tightly couple the code generating all figures and values in the slides with other presentation content
enabling you (or&nbsp;others) to recreate everything with a&nbsp;single `quarto render ...` command, ensuring that slide
contents are by-design in&nbsp;sync with the code, in the spirit of "reproducible manuscripts" approach
(see,&nbsp;e.g.,&nbsp;[Perkel 2022, Nature](https://doi.org/10.1038/d41586-022-00563-z)).

In addition, the sample notebook includes BibTeX-format bibliography catalogue set up to automatically
render `[@label]` references as slide footnotes.
<span class="emoji">📚</span> In addition, the sample notebook includes BibTeX-format bibliography setup which automatically
adds reference footnotes for slides with `[@label]` citations.

## How to use it?
## <span class="emoji">🧭</span> How to use it?

To use it, grab the [example `.ipynb` file](https://github.com/habemus-python/quarto-agh-slides/blob/main/slides.ipynb) and edit it
<span class="emoji">📝</span> To use it, grab the [example `.ipynb` file](https://github.com/habemus-python/quarto-agh-slides/blob/main/slides.ipynb) and edit it
with your favourite Jupyter notebook tool.

To generate HTML files for presentation, do `quarto render slides.ipynb --execute --to revealjs`, the output (`slides.html` file) should look like this:
<span class="emoji">🌐</span> To generate HTML files for presentation, do `quarto render slides.ipynb --execute --to revealjs`, the output (`slides.html` file) should look like this:

<p align="center">
<img
Expand All @@ -27,18 +28,18 @@ To generate HTML files for presentation, do `quarto render slides.ipynb --execut
/>
</p>

To convert it to a pdf, open in a browser, select `☰ :: Tools :: PDF Export Mode` and use the browser's print dialog to save a pdf.
<span class="emoji">🖨️</span> To convert it to a pdf, open in a browser, select `☰ :: Tools :: PDF Export Mode` and use the browser's print dialog to save a pdf.

To learn more about Quarto/Revealjs features, e.g., speaker notes, multi-column slides, layout helpers, absolute positioning, animations, backgrounds, videos,
slide navigation, speaker view, audible accessibility helpers, automatic slide stepping, timing, chalkboard plugin, multiplexing and many more,
<span class="emoji">✨</span> To learn more about Quarto/Revealjs features, e.g., speaker notes, multi-column slides, layout helpers, absolute positioning, animations, backgrounds, videos,
slide numbering and navigation, speaker view, audible accessibility helpers, automatic slide stepping, timing, chalkboard plugin, multiplexing and many more,
[read the friendly manual](https://quarto.org/docs/presentations/revealjs/).

## Quarto templates from other universities
## <span class="emoji">🏛️</span> Quarto templates from other universities
- [monash.edu (Melbourne)](https://github.com/quarto-monash)
- [uu.nl (Utrecht)](https://github.com/UtrechtUniversity/uu-quarto-presentation-template)
- [ed.ac.uk (Edinburgh)](https://open.ed.ac.uk/how-to-make-a-professionally-sexy-quarto-presentation/)
- [warwick.ac.uk (Warwick)](https://github.com/warwick-stats-resources/warwickpres)
- [mq.edu.au (Sydney)](https://github.com/thomas-fung/quarto-mq-revealjs-theme)

## Other AGH presentation templates
## <span class="emoji">🗂️</span> Other AGH presentation templates
- [templates listed at the official agh.edu.pl page](https://www.agh.edu.pl/en/university/multimedia/presentation-templates)
Loading