README.md

UCL talk template with marp

This is my very minimalist template for UCL talks using marp/marpit. Anyone in UCL is welcome to use the template! If you're not from UCL then please remove the UCL branding. (But at that point, you're just using the default theme!)

How to use this template

1. Follow the instructions for creating a new repository from a template (tl; dr click on "Use this template").

2. Edit slides.md to build your talk.

   • Follow the excellent marpit docs for inserting images and backgrounds and split screens etc. Put images in the assets folder.
   • I recommend the marp-vscode extension if you use Visual Studio Code.

3. If you push to GitHub there is a workflow to automatically build the talk with marp-cli and publish the result to a gh-pages branch.

   • Go to the repo settings and enable GitHub pages (follow from step 5 of these instructions), you should then see your slides at https://yourusername.github.io/name-of-your-talk-repo.

If you're not ready or don't want to publish your talk then don't do the final steps.

Further reading

• UCL branding instructions.
• UCL banner usage rules.