JackV committed Oct 04, 2018 1 2 # POuL reveal.js template  Davide Depau committed Sep 21, 2019 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 This is the reveal.js slides template for all POuL lessons. It is mandatory for new courses to either use this or the Beamer base template. ## Important - Slides versioning Slides repositories should be placed under the appropriate suborganization, under [/corsi](https://gitlab.poul.org/corsi). All years slides should be **in the same repo**, even if they use different technologies. Use a branch revealjs/beamer to distinguish the two trees. All years slides must be tagged appropriately: bash git tag -m 2019 2019  If you need to move a tag, add --force. You might need to ask a sysadmin if you need to force-push.  JackV committed Oct 04, 2018 23   JackV committed Oct 05, 2018 24 25 ## Getting Started  Davide Depau committed Sep 21, 2019 26 In order for the slides to work (ie. display anything) you need to run:  Roberto Bochet committed Nov 03, 2019 27 git submodule update --init  JackV committed Oct 05, 2018 28   Davide Depau committed Sep 21, 2019 29 In case you need the mathjax submodule as well  Roberto Bochet committed Nov 03, 2019 30 31 32 git submodule update --init --recursive You can add --depth 1 to the previous commands to improve the update speed but only if you are using the latest reveal.js module.  JackV committed Oct 05, 2018 33   JackV committed Oct 04, 2018 34 35 36 37 ## How do I use this thing? ### Where do I write my stuff?  Davide Depau committed Sep 21, 2019 38 39 40 41 1. Create a new repo into the appropriate sub-organization 1. Clone this repo 1. Change origin to your repo 1. Push  Roberto Bochet committed Nov 03, 2019 42 43 1. Add author's info in ./slides/intro.html and ./slides/outro.html 1. Put your content in ./slides/content.md or add slides files in ./slides/ and link these in ./index.html  JackV committed Oct 04, 2018 44 45 46  ### How do I write my stuff?  Davide Depau committed Sep 21, 2019 47 Using Vim.  JackV committed Oct 04, 2018 48   Davide Depau committed Sep 21, 2019 49 [Here][markdown-guide] you can find a comprehensive guide to the Markdown syntax.  JackV committed Oct 04, 2018 50 51 52 53  Remember to use three dashes (---) to create a new slide horizontally and four dashes (----) to create a new one vertically.  Davide Depau committed Sep 21, 2019 54 Use Notes: to add reader notes to your slide.  JackV committed Oct 04, 2018 55   Roberto Bochet committed Nov 03, 2019 56 57 Alternatively you can write your slides with pure **html**  Davide Depau committed Sep 21, 2019 58 ### How do I see my stuff?  JackV committed Oct 04, 2018 59   Roberto Bochet committed Nov 03, 2019 60 You can run ./deploy.py with Python 3 and open the provided link in your browser.  JackV committed Oct 04, 2018 61   Davide Depau committed Sep 21, 2019 62 ## How do I make a PDF out of the slides?  JackV committed Oct 04, 2018 63   Roberto Bochet committed Nov 03, 2019 64 Click on the printer symbol in the bottom-left corner to get the printable version of the slides.  JackV committed Oct 04, 2018 65   Davide Depau committed Sep 21, 2019 66 Then just use the print function of your browser to make a PDF of the page.  JackV committed Oct 04, 2018 67   Davide Depau committed Sep 21, 2019 68 69 On **Chrome/ium** make sure you **scroll to the top** of your slides before printing, otherwise, for whatever reason, the background of the slides will be borked.  JackV committed Oct 04, 2018 70   Davide Depau committed Sep 21, 2019 71 72 On **Firefox** it is advised to enable *Print Backgrounds* under the *Options* tab, to select paper size *Choukei 2 Envelope* and *Landscape* orientation.  JackV committed Oct 04, 2018 73   Davide Depau committed Sep 21, 2019 74 75 [download]: https://gitlab.poul.org/corsi/revealjs-poul/repository/archive.zip?ref=master [markdown-guide]: https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet  JackV committed Oct 04, 2018 76   Davide Depau committed Sep 21, 2019 77 ## GitLab Pages slides preview  JackV committed Oct 04, 2018 78   Davide Depau committed Sep 21, 2019 79 80 It is possible to use GitLab Pages to preview the slides in order to send them for review to the mailing list.  JackV committed Oct 04, 2018 81   Davide Depau committed Sep 21, 2019 82 83 84 85 #### Important GitLab Pages **must not** be used to actually publish the slides, and links to it **must not** be given to course attendants. Use [slides.poul.org](https://slides.poul.org) instead.  JackV committed Oct 04, 2018 86 87   Davide Depau committed Sep 21, 2019 88 89 A .gitlab-ci.yml config is provided in this template. It simply copies the whole master branch of the repo to the Pages website.  JackV committed Oct 04, 2018 90   Davide Depau committed Sep 21, 2019 91 To use it:  JackV committed Oct 04, 2018 92   Davide Depau committed Sep 21, 2019 93 94 95 - Enable CI for your repository: - Go to Settings > General > Visibility - Enable Pipelines under the Repository section  JackV committed Oct 04, 2018 96   Davide Depau committed Sep 21, 2019 97 98 A CI build job for the master branch should run automatically. If it doesn't, go to CI / CD and click Run Pipeline.  JackV committed Oct 04, 2018 99   Davide Depau committed Sep 21, 2019 100 You can find the link to your Pages preview under Settings > Pages.