https://github.com/j0weiss/dockerized-reveal.js
Running a reveal.js presentation in a Docker container.
https://github.com/j0weiss/dockerized-reveal.js
docker presentation-tools revealjs
Last synced: about 1 month ago
JSON representation
Running a reveal.js presentation in a Docker container.
- Host: GitHub
- URL: https://github.com/j0weiss/dockerized-reveal.js
- Owner: j0weiss
- License: mit
- Created: 2017-12-30T17:30:42.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-12-30T17:31:16.000Z (over 8 years ago)
- Last Synced: 2024-06-11T07:47:16.908Z (about 2 years ago)
- Topics: docker, presentation-tools, revealjs
- Language: Shell
- Size: 2.93 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Dockerized Reveal.js Framework
This repository contains a Dockerfile to run a [reveal.js](https://github.com/hakimel/reveal.js) presentation in a Docker container.
## Usage
### Build the Docker image
```sh
docker build -t revealjs .
```
### Run the Docker container
To run the presentation simply run:
```sh
./runPresentation.sh
```
Then you can view the presentation under [localhost:8080](http://localhost:8080).
## Creating your presentation
### Configuration
The configuration of the presentation is done via the `index.html` file in the `presentation` folder. For the default reveal.js `index.html` simply remove the `.example` ending in the shipped example HTML file. This HTML file gets mounted to the Docker container and is the entry file like it is described in the [reveal.js repository](https://github.com/hakimel/reveal.js).
### Creating the slides
The content and styles as well as additional JavaScript logic lives also in the `presentation` folder:
```
presentation
├── assets
│ ├── css
│ │ └── styles.css
│ └── js
│ └── custom.js
├── index.html
└── slides
└── slides.md
```
The folder structure is the same as it is in the docker container. So you can reference your styles and JavaScript files in the `index.html` file like you would do it according to the outlined folder stucture.
The content of your slides is defined in the `slides.md` file (you'll find an `slides.md.example` file in the `slides` folder). Currently only external Markdown is supported.
For more documentation on how to customize your presentation see the [repository for reveal.js](https://github.com/hakimel/reveal.js).
## Licence
This code is licensed under the [MIT Licence](https://opensource.org/licenses/MIT).