To receive notifications about scheduled maintenance, please subscribe to the mailing-list gitlab-operations@sympa.ethz.ch. You can subscribe to the mailing-list at https://sympa.ethz.ch

README.md 772 Bytes
Newer Older
kchung's avatar
kchung committed
1
2
3
4
5
6
# This is template to use Reveal.js for presentations.

Warning: the template is not yet completed.

## Dependency
	
kchung's avatar
kchung committed
7
- Since we are using [Vite](https://vitejs.dev/) as front-end and [Reveal.js](https://revealjs.com/) for the slides, [Node.js](https://nodejs.org/en/) version >=12.0.0 is required.
kchung's avatar
kchung committed
8
9
10

## How to use

kchung's avatar
kchung committed
11
Clone this repository to your local directory
kchung's avatar
kchung committed
12
13

```bash
kchung's avatar
kchung committed
14
git clone git@gitlab.ethz.ch:kchung/reveal-js-ifd-theme.git
kchung's avatar
kchung committed
15
16
```

kchung's avatar
kchung committed
17
Install dependencies (package.json should have revealjs and vite as devDependencies)
kchung's avatar
kchung committed
18
19
20
21
22
23
24
25
26
27
28

```bash
npm install
```

Edit index.html to create reveal.js slides

Then, start a local server to bundle and serve the presentation
```bash
npm run dev
```
kchung's avatar
kchung committed
29
30

Now, you can access to your slidese from your brower on localhost, port 3000 (localhost:3000)