bracken_streamlit / remark_slides.md
hathawayj's picture
first push
59a2d05
|
raw
history blame
1.03 kB
# GitHub Pages Slideshow with [Remark](https://github.com/gnab/remark)
This template is made from [Remark](https://github.com/gnab/remark), an open source tool to help create and display slideshows from markdown. For questions, see [Remark's documentation](https://github.com/gnab/remark). 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](https://github.com/gnab/remark/wiki)
- Press `C` to clone a display; then press `P` to switch to presenter mode. Open help menu with `h`
Fork this repository to get started!