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 1.31 KB
Newer Older
kchung's avatar
kchung committed
1 2 3 4 5
# This is template to use Reveal.js for presentations.

Warning: the template is not yet completed.

## Dependency
kchung's avatar
kchung committed
6

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 18
Run shell script to install dependencies. This script will install all ```nodejs``` dependencies and remove git related files and folder to avoid accidental commits while you are making the presentation.
**Removing git related files/folders is for personal reason. You shouldn't do that if you clone this repo.**
kchung's avatar
kchung committed
19 20

```bash
kchung's avatar
kchung committed
21 22
chmod 777 setup.sh
./setup.sh
kchung's avatar
kchung committed
23 24 25 26 27 28 29 30
```

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
31

kchung's avatar
kchung committed
32

kchung's avatar
kchung committed
33
Now, you can access to your slidese from your browser on localhost, port 3000 (localhost:3000)
kchung's avatar
kchung committed
34 35 36 37 38 39

## Integrate terminal inside of the slides

You can add terminal inside of the slides. To accomplish this, you need to install dependencies in `ifd-theme/terminal/client` and `ifd-theme/terminal/server` by running ```npm install```.

Then, before using terminal, please run the server side application using ```npm start```
kchung's avatar
kchung committed
40