https://github.com/joelnb/presentation-builder

A version of https://github.com/justin-vanwinkle/presentation-builder with some changes that make it work better for me.
https://github.com/joelnb/presentation-builder

Last synced: 3 months ago
JSON representation

A version of https://github.com/justin-vanwinkle/presentation-builder with some changes that make it work better for me.

• Host: GitHub
• URL: https://github.com/joelnb/presentation-builder
• Owner: joelnb
• License: unlicense
• Created: 2021-09-02T21:59:33.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-06-17T18:58:28.000Z (7 months ago)
• Last Synced: 2024-10-17T18:03:46.545Z (3 months ago)
• Language: Shell
• Size: 37.1 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Presentation Builder

A simplistic way to create stunning presentations with speed using [Reveal.js](https://github.com/hakimel/reveal.js) and Docker. Originally based on work by [justin-vanwinkle](https://github.com/justin-vanwinkle) - [justin-vanwinkle/presentation-builder](https://github.com/justin-vanwinkle/presentation-builder).

## Capabilities

1. Convert markdown to reveal.js presentation slides.

2. Watch input for changes and automatically rebuild presentation (manual page refresh required).

3. Serve your presentation from a distributable container.

## Prerequisites

Docker is the only requirement.

## Usage

In any case, this repo can be cloned and used as a skeleton for creating your presentation.

### Working on your presentation

* Run `prepare.sh`

* Modify `input/slides.md`

* Place resources in `input/res/`

**Notes:**

* `input/slides.md` represents your slides.

* Any resources that you reference in `input/slides.md` should be placed in `input/res/`.

* `prepare.sh` rebuilds the presentation upon changes to the input folder.  The browser requires manual refresh however.

### Presenting Locally

Run `present.sh`.

The only difference between this and `prepare.sh` is that `present.sh` does not monitor for changes.  It will still serve the content from the container, however.

### Distributing

If you wish to serve your talk in a simple way, you can grab the files from the `output` folder and drop them anywhere you can serve a webpage.