Verified Commit 954ad79e authored by Davide Depau's avatar Davide Depau

Merge remote-tracking branch 'reveal/master'

parents 9be70187 4aa71933
Pipeline #56 passed with stage
in 50 seconds
# POuL reveal.js template
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.
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.
## Getting Started
In order for the slides to work (ie. display anything) you need to run:
`git submodule update --init --depth 1`
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
In case you need the mathjax submodule as well
`git submodule update --init --depth 1 --recursive`
## How do I use this thing?
### Where do I write my stuff?
[Download][download] this repo and put your content inside the 'content.md'
file placed in the root of this directory. What were you expecting?
1. Create a new repo into the appropriate sub-organization
1. Clone this repo
1. Change origin to your repo
1. Push
1. Edit `content.md` and `index.html`
### How do I write my stuff?
Using a text editor and typing Markdown syntax on your keyboard.
Using Vim.
[Here][markdown-guide] you can find a comprehensive guide to the syntax.
[Here][markdown-guide] you can find a comprehensive guide to the Markdown syntax.
Remember to use three dashes (`---`) to create a new slide horizontally and
four dashes (`----`) to create a new one vertically.
### How do I see my stuff?
Use `Notes:` to add reader notes to your slide.
Make sure you have Python 3 installed. Nothing more is required.
### How do I see my stuff?
Make the deploy.py script executable with
- You can display `index.html` with your browser
or
- You can run `deploy.py` with Python 3 and open the provided link in your browser.
chmod +x deploy.py
## How do I make a PDF out of the slides?
Then just run
Append `?print-pdf` at the end of the URL.
./deploy.py --show
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`.
A new tab will open in your default browser showing the presentation.
Then just use the print function of your browser to make a PDF of the page.
You can spacify your browser using the `BROWSER` environment variable.
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.
BROWSER=surf ./deploy.py --show
On **Firefox** it is advised to enable *Print Backgrounds* under the *Options* tab,
to select paper size *Choukei 2 Envelope* and *Landscape* orientation.
You can see what kind of trickery this script is able to do running it with the
`-h` or `--help` flag.
[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
#### Why?
## GitLab Pages slides preview
This is required since modern browsers won't allow you to include a local file
(the Markdown document) from JavaScript.
It is possible to use GitLab Pages to preview the slides in order to send them for review
to the mailing list.
The Python script will run a small HTTP server and fix this issue.
#### 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.
## How do I make a PDF out of the slides?
Append `?print-pdf` at the end of the URL.
A `.gitlab-ci.yml` config is provided in this template. It simply copies the whole
`master` branch of the repo to the Pages website.
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`.
To use it:
Then just use the print function of your browser to make a PDF of the page.
- Enable CI for your repository:
- Go to `Settings` > `General` > `Visibility`
- Enable `Pipelines` under the `Repository` section
On **Firefox** it is advised to enable *Print Backgrounds* under the *Options* tab,
to select paper size *Choukei 2 Envelope* and *Landscape* orientation.
A CI build job for the `master` branch should run automatically. If it doesn't, go to
`CI / CD` and click `Run Pipeline`.
[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
You can find the link to your Pages preview under `Settings` > `Pages`.
......@@ -299,11 +299,11 @@ body {
}
.reveal section.outro img.logo {
max-height: 40vh;
max-height: 20vh;
padding: 0;
}
.reveal section.outro img.cc {
max-height: 10vh;
max-height: 5vh;
padding: 0;
}
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment