README.md 2.26 KB
Newer Older
1
# POuL reveal.js template
2

3
4
5
6
This is a base template that will allow you to make state-of-art presentations
using advanced technologies such as Markdown, reveal.js (thus the
industry-standard language JavaScript), still complying with the mandatory
design guidelines.
7

fcremo (Filippo Cremonese)'s avatar
fcremo (Filippo Cremonese) committed
8
9
10
11
12
13
14
15
## Getting Started

In order for the slides to work (ie. display anything) you need to run:  
`git submodule update --init --depth 1`  

In case you need the mathjax submodule as well  
`git submodule update --init --depth 1 --recursive`

16
## How do I use this thing?
17

18
### Where do I write my stuff?
19

20
21
[Download][download] this repo and put your content inside the 'content.md'
file placed in the root of this directory. What were you expecting?
22

23
### How do I write my stuff?
24

25
Using a text editor and typing Markdown syntax on your keyboard.
26

27
[Here][markdown-guide] you can find a comprehensive guide to the syntax.
28

29
30
Remember to use three dashes (`---`) to create a new slide horizontally and
four dashes (`----`) to create a new one vertically.
31

32
### How do I see my stuff?
33

34
Make sure you have Python 3 installed. Nothing more is required.
35

36
Make the deploy.py script executable with
37

38
    chmod +x deploy.py
39

40
Then just run
41

42
    ./deploy.py --show
43

44
A new tab will open in your default browser showing the presentation.
45

46
You can spacify your browser using the `BROWSER` environment variable.
47

48
    BROWSER=surf ./deploy.py --show
49

50
51
You can see what kind of trickery this script is able to do running it with the
`-h` or `--help` flag.
52

53
#### Why?
54

55
56
This is required since modern browsers won't allow you to include a local file
(the Markdown document) from JavaScript.
57

58
The Python script will run a small HTTP server and fix this issue.
59

60
## How do I make a PDF out of the slides?
61

62
Append `?print-pdf` at the end of the URL.
63

64
65
For instance if you're running the `deploy.py` script locally the URL will be
something like `http://127.0.0.1:8080/?print-pdf`.
66

67
Then just use the print function of your browser to make a PDF of the page.
68

fcremo (Filippo Cremonese)'s avatar
fcremo (Filippo Cremonese) committed
69
70
On **Firefox** it is advised to enable *Print Backgrounds* under the *Options* tab,
to select paper size *Choukei 2 Envelope* and *Landscape* orientation.
71

72
73
[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