pandoc-lecturenotes

This repo is forked from https://github.com/mxpiotrowski/pandoc-lecturenotes - see that repo for additional documentation.

To create a new presentation:

1. Create a directory under /md/ . Inside that directory, create a file called slides.md
2. Inside slides.md, write your presentation. At minimum, include a pandoc title block. For each slide in the presentation, wrap it in a :::slide block. Anything outside of those blocks will appear only in the notes PDF. See md/other/short.md for a template.
3. To include images, use paths relative to slides.md
4. To generate, run ./generate.sh followed by the path to the directory created in step 1
5. It will copy everything from the directory created in step 1 under generated/, along with two new files: index.html and notes.pdf.

Eg:

• To create a presentation for web class, I crated the directory: md/web/1_internet, which includes images and slides.md
• I ran ./generate.sh web/1_internet
• It created generated/web/1_internet including notes.pdf and slides.md

Tips:

• Follow Pandoc Reveal conventions - title slides should be a single h1 tag (in markdown, #) with no other content, and there should be at least one content slide between each title slide. Include ::: {.slide .presentation} at the top of these slides, which will render them as nice markdown in the PDF notes, instead of pictures of embedded slides.
• A previous version of this repo included an extra templating engine that made it easier to re-use components between presentations. For simplicity, I did not include that here. Each presentation is standalone and components need to be copy/pasted.