hathawayj / remark-template

Make sure to change the below URL to your repo after you create your repository from this template. Turn on github.io pages from the settings and set your source to master and root.

GitHub Pages Slideshow with Remark

This template is made from Remark, an open source tool to help create and display slideshows from markdown. For questions, see Remark's documentation. I have added a Github action to convert the slides to a pdf in the slides branch.

The most important things to know are:

• Enable GitHub Pages from master for the slides to work
• Once enabled, the slides will be visible at https://USERNAME.github.io/REPOSITORY-NAME/#1, like https://brianamarie.github.io/slideshow-on-pages/#1
• Edit the index.html file to edit the slides
• Slides are separated by ----
• Presenter notes after ??? within one slide
• Toggle presenter notes during presentation with P
• Read the full guide to remark markdown
• Press C to clone a display; then press P to switch to presenter mode. Open help menu with h

Github Action Settings

You will need to adjust the settings for the github action to create the pdf of your presentation.

Fork this repository to get started!