Skip to content

Latest commit

 

History

History
60 lines (36 loc) · 2.5 KB

README.md

File metadata and controls

60 lines (36 loc) · 2.5 KB

talkTemplate

Build html pdf

Abstract

Here it goes the abstract of the slides. I show here how to setup this template, basic syntax for creating the content, and some JS macros.

Take home messages

  • Start with a template is much easier to start your presentation
  • Here you don't have to worry about dependencies, deployment and how to generate a PDF

Setup

First click on the Use this template button to fork this repository.

After cloning the forked repository to your local computer, it is recomended to install all (R packages 📦) dependencies:

make install

If you use other R packages for your presentation, add them to the requeriments.yml file

Once dependencies are solved, you can server your presentation on local to be automatically updated while editing:

make server

Finally, publish your final html presentation with:

make

PDF output

To export the html presentation to pdf:

make pdf

But you need Google Chrome installed (or other chromium such as Brave; although you have to specify the full path to find the chromium browser in the makefile). You can also use decktape.

Note that if you have activated GitHub actions to build your presentation, it will automatically compile a pdf and push it to the gh-pages branch.

Host your presentation on GitHub

  • After forking this template, go to the Settings page of your repo (https://github.com/USER_NAME/REPO_NAME/settings/pages). In the Source section, make sure to choose the options branch: gh-pages and root.
  • Update the badges link on the README.md with your GitHub username and the name of your forked repository.

Now each commit will trigger GitHub actions to compile your presentation in both html and pdf format, and push them to the gh-pages branch.

Note: after forking the template, it usually takes few hours to your presentation be available on the link https://USER_NAME.github.io/REPO_NAME/

Slide content

You can find in the presentation the basic syntax to create the common elements (Sections, figures, tables, etc) along with some resourceful links.